0.1.96 • Published yesterdayCLI

@insforge/cli

Licence

Apache-2.0

Version

0.1.96

Deps

Size

615 kB

Vulns

Weekly

2.5K

Summary Dependency Versions

@insforge/cli

Command line tool for the InsForge platform. Manage your databases, edge functions, storage, deployments, payments, secrets, and more — directly from the terminal.

Designed to be both human-friendly (interactive prompts, formatted tables) and agent-friendly (structured JSON output, non-interactive mode, semantic exit codes).

Requires Node.js >= 18. We recommend running via npx so you always get the latest version — no global install needed.

Quick Start

# Login via browser (OAuth)
npx @insforge/cli login

# Or login with email/password
npx @insforge/cli login --email

# Check current user
npx @insforge/cli whoami

# List all organizations and projects
npx @insforge/cli list

# Link current directory to a project
npx @insforge/cli link

# Query the database
npx @insforge/cli db tables
npx @insforge/cli db query "SELECT * FROM users LIMIT 10"

Authentication

If you run any command without being logged in, the CLI will automatically open your browser and start the login flow — no need to run npx @insforge/cli login first.

npx @insforge/cli login

Opens your browser to the InsForge authorization page using OAuth 2.0 Authorization Code + PKCE. A local callback server receives the authorization code and exchanges it for tokens. Credentials are stored in ~/.insforge/credentials.json.

npx @insforge/cli login --email

Prompts for email and password interactively, or reads from environment variables in non-interactive mode:

INSFORGE_EMAIL=user@example.com INSFORGE_PASSWORD=secret npx @insforge/cli login --email --json

Logout

npx @insforge/cli logout

Global Options

All commands support the following flags:

Flag	Description
`--json`	Output in JSON format (useful for scripts and AI agents)
`--api-url <url>`	Override the Platform API URL
`-y, --yes`	Skip confirmation prompts

The --project-id <id> flag is command-specific and is supported by link when you want to link a directory directly to a known project.

Commands

The orgs, projects, and records command groups are registered but hidden (hidden: true in src/index.ts) and are intentionally excluded from this reference. Use npx @insforge/cli list instead of orgs/projects; records is internal and not supported for direct use.

Top-Level

`npx @insforge/cli whoami`

Show the current authenticated user.

npx @insforge/cli whoami
npx @insforge/cli whoami --json

`npx @insforge/cli list`

List all organizations and their projects in a grouped table.

npx @insforge/cli list
npx @insforge/cli list --json

`npx @insforge/cli create`

Create a new InsForge project interactively.

npx @insforge/cli create
npx @insforge/cli create --name "my-app" --org-id <org-id> --region us-east
npx @insforge/cli create --name "my-app" --template nextjs --auth better-auth   # scaffold from a built-in template
npx @insforge/cli create --name "my-app" --marketplace <slug>                   # install a marketplace template

Options:

--name <name>: Project name
--org-id <id>: Organization ID
--region <region>: Deployment region (us-east, us-west, eu-central, ap-southeast)
--template <template>: Built-in template (react, nextjs, chatbot, crm, e-commerce, todo, or empty)
--marketplace <slug>: Install a marketplace template by slug (browse: https://insforge.dev/templates)
--auth <provider>: Wire a third-party auth provider into the chosen template (currently: better-auth)

`npx @insforge/cli link`

Link the current directory to an InsForge project. Creates .insforge/project.json with the project ID, API key, and OSS host URL.

# Interactive: select from a list
npx @insforge/cli link

# Non-interactive (platform login)
npx @insforge/cli link --project-id <id> --org-id <org-id>

# OSS / self-hosted: link via host URL + API key (no platform login required)
npx @insforge/cli link \
  --api-base-url https://<app-key>.<region>.insforge.app \
  --api-key <your-project-api-key>

For OSS or self-hosted deployments, you can link directly using the host URL and API key — the CLI skips the platform OAuth flow and writes the credentials straight into .insforge/project.json. The host URL format is https://{app_key}.{region}.insforge.app (e.g. https://uhzx8md3.us-east.insforge.app).

`npx @insforge/cli current`

Show current CLI context (authenticated user, linked project).

npx @insforge/cli current
npx @insforge/cli current --json

`npx @insforge/cli metadata`

Show backend metadata including auth configuration, database tables, storage buckets, edge functions, AI models, and realtime channels.

npx @insforge/cli metadata
npx @insforge/cli metadata --json

`npx @insforge/cli logs`

Fetch backend container logs.

npx @insforge/cli logs <source> [options]

Sources: insforge.logs, postgREST.logs, postgres.logs, function.logs

Options:

--limit <n>: Number of log entries to return (default: 20)

Examples:

npx @insforge/cli logs insforge.logs
npx @insforge/cli logs postgres.logs --limit 50
npx @insforge/cli logs function.logs --json

`npx @insforge/cli docs`

Browse InsForge SDK documentation.

npx @insforge/cli docs [feature] [language]

Features: db, storage, functions, auth, ai, realtime, instructions Languages: typescript, swift, kotlin, rest-api

Examples:

# List all available docs
npx @insforge/cli docs

# Specific feature/language docs
npx @insforge/cli docs instructions           # Show backend setup instructions
npx @insforge/cli docs db typescript          # Show TypeScript database SDK docs
npx @insforge/cli docs auth swift             # Show Swift auth SDK docs
npx @insforge/cli docs storage rest-api       # Show REST API storage docs

Branch — `npx @insforge/cli branch`

Manage backend branches of the currently linked project.

`npx @insforge/cli branch list`

List branches of the currently linked project.

npx @insforge/cli branch list
npx @insforge/cli branch list --json

`npx @insforge/cli branch create <name>`

Create a branch from the currently linked project.

npx @insforge/cli branch create feature-x
npx @insforge/cli branch create feature-x --mode schema-only   # full | schema-only (default: full)
npx @insforge/cli branch create feature-x --no-switch          # do not auto-switch context after creation

`npx @insforge/cli branch switch [name]`

Switch this directory's context to a branch (or back to the parent project).

npx @insforge/cli branch switch feature-x
npx @insforge/cli branch switch --parent   # switch back to the parent project

`npx @insforge/cli branch merge <name>`

Merge a branch back to its parent project.

npx @insforge/cli branch merge feature-x
npx @insforge/cli branch merge feature-x --dry-run            # compute the diff and print rendered SQL; do not apply
npx @insforge/cli branch merge feature-x --save-sql diff.sql  # write rendered SQL preview to a file

`npx @insforge/cli branch reset <name>`

Reset a branch's database back to T0 (the parent snapshot at branch creation).

npx @insforge/cli branch reset feature-x

`npx @insforge/cli branch delete <name>`

Delete a branch.

npx @insforge/cli branch delete feature-x

AI — `npx @insforge/cli ai`

Configure local development for the InsForge Model Gateway. The setup command fetches the linked project's active OpenRouter key from the InsForge backend and writes it as the server-only OPENROUTER_API_KEY variable.

npx @insforge/cli ai setup
npx @insforge/cli ai setup --env-file .env
npx @insforge/cli ai setup --json

By default the CLI writes .env.local and adds .env*.local to .gitignore when needed. For deployments such as Vercel, add OPENROUTER_API_KEY to the provider's server/runtime environment. Do not rename the key to NEXT_PUBLIC_, VITE_, or PUBLIC_; those prefixes expose values to browser code.

Database — `npx @insforge/cli db`

`npx @insforge/cli db query <sql>`

Execute a raw SQL query.

npx @insforge/cli db query "SELECT * FROM users LIMIT 10"
npx @insforge/cli db query "SELECT count(*) FROM orders" --json
npx @insforge/cli db query "SELECT * FROM pg_tables" --unrestricted

`npx @insforge/cli db tables`

List all database tables.

npx @insforge/cli db tables
npx @insforge/cli db tables --json

`npx @insforge/cli db functions`

List all database functions.

npx @insforge/cli db functions

`npx @insforge/cli db indexes`

List all database indexes.

npx @insforge/cli db indexes

`npx @insforge/cli db policies`

List all RLS policies.

npx @insforge/cli db policies

`npx @insforge/cli db triggers`

List all database triggers.

npx @insforge/cli db triggers

`npx @insforge/cli db rpc <functionName>`

Call a database function via RPC.

npx @insforge/cli db rpc my_function --data '{"param1": "value"}'

`npx @insforge/cli db export`

Export database schema and/or data.

npx @insforge/cli db export --output schema.sql
npx @insforge/cli db export --data-only --output data.sql

`npx @insforge/cli db import <file>`

Import database from a local SQL file.

npx @insforge/cli db import schema.sql

`npx @insforge/cli db migrations`

Manage database migration files.

npx @insforge/cli db migrations list          # list applied remote migrations
npx @insforge/cli db migrations fetch         # fetch applied remote migrations into migrations/
npx @insforge/cli db migrations new add-users # create a new local migration file (lowercase, digits, hyphens only)
npx @insforge/cli db migrations up --all      # apply all pending local migrations
npx @insforge/cli db migrations up --to 20260101_add-users  # apply up to a version/file

`npx @insforge/cli db connection-string`

Print the project Postgres connection URL (cloud projects only).

npx @insforge/cli db connection-string

Functions — `npx @insforge/cli functions`

`npx @insforge/cli functions list`

List all edge functions.

npx @insforge/cli functions list
npx @insforge/cli functions list --json

`npx @insforge/cli functions code <slug>`

View the source code of an edge function.

npx @insforge/cli functions code my-function
npx @insforge/cli functions code my-function --json

`npx @insforge/cli functions deploy <slug>`

Deploy an edge function. Creates the function if it doesn't exist, or updates it.

npx @insforge/cli functions deploy my-function --file ./handler.ts
npx @insforge/cli functions deploy my-function --file ./handler.ts --name "My Function" --description "Does something"

`npx @insforge/cli functions invoke <slug>`

Invoke an edge function.

npx @insforge/cli functions invoke my-function --data '{"key": "value"}'
npx @insforge/cli functions invoke my-function --method GET
npx @insforge/cli functions invoke my-function --data '{"key": "value"}' --json

`npx @insforge/cli functions delete <slug>`

Delete an edge function.

npx @insforge/cli functions delete my-function
npx @insforge/cli functions delete my-function -y  # skip confirmation

Storage — `npx @insforge/cli storage`

`npx @insforge/cli storage buckets`

List all storage buckets.

npx @insforge/cli storage buckets
npx @insforge/cli storage buckets --json

`npx @insforge/cli storage create-bucket <name>`

Create a new storage bucket.

npx @insforge/cli storage create-bucket images
npx @insforge/cli storage create-bucket private-docs --private

`npx @insforge/cli storage delete-bucket <name>`

Delete a storage bucket and all its objects.

npx @insforge/cli storage delete-bucket images
npx @insforge/cli storage delete-bucket images -y   # skip confirmation

`npx @insforge/cli storage list-objects <bucket>`

List objects in a storage bucket.

npx @insforge/cli storage list-objects images
npx @insforge/cli storage list-objects images --prefix "avatars/" --limit 50

`npx @insforge/cli storage upload <file>`

Upload a file to a storage bucket.

npx @insforge/cli storage upload ./photo.png --bucket images
npx @insforge/cli storage upload ./photo.png --bucket images --key "avatars/user-123.png"

`npx @insforge/cli storage download <objectKey>`

Download a file from a storage bucket.

npx @insforge/cli storage download avatars/user-123.png --bucket images
npx @insforge/cli storage download avatars/user-123.png --bucket images --output ./downloaded.png

Deployments — `npx @insforge/cli deployments`

`npx @insforge/cli deployments deploy [directory]`

Deploy a frontend project. Zips the source, uploads it, and polls for build completion (up to 2 minutes).

npx @insforge/cli deployments deploy
npx @insforge/cli deployments deploy ./my-app
npx @insforge/cli deployments deploy --env '{"API_URL": "https://api.example.com"}'

To exclude files from the upload, add a .vercelignore file to the deploy directory. It uses .gitignore syntax (including ! negation) and is applied on top of the built-in excludes (node_modules, .git, .env, etc. — these always stay excluded and cannot be re-included).

# .vercelignore
*.md
drafts/
!IMPORTANT.md

`npx @insforge/cli deployments list`

List all deployments.

npx @insforge/cli deployments list
npx @insforge/cli deployments list --limit 5 --json

`npx @insforge/cli deployments status <id>`

Get deployment details and status.

npx @insforge/cli deployments status abc-123
npx @insforge/cli deployments status abc-123 --sync   # sync status from Vercel first

`npx @insforge/cli deployments cancel <id>`

Cancel a running deployment.

npx @insforge/cli deployments cancel abc-123

`npx @insforge/cli deployments env`

Manage deployment environment variables.

npx @insforge/cli deployments env list                       # list all deployment env vars
npx @insforge/cli deployments env set API_URL https://api.example.com  # create or update a variable
npx @insforge/cli deployments env delete <id>                # delete a variable by ID

`npx @insforge/cli deployments metadata`

Show current deployment metadata and domain URLs.

npx @insforge/cli deployments metadata
npx @insforge/cli deployments metadata --json

`npx @insforge/cli deployments slug [slug]`

Show, set, or remove the custom deployment slug.

npx @insforge/cli deployments slug
npx @insforge/cli deployments slug my-app
npx @insforge/cli deployments slug --remove

Domains — `npx @insforge/cli domains`

Register a domain through the user's Cloudflare account, attach it to the linked InsForge deployment, sync Cloudflare DNS records, and verify SSL/custom domain readiness.

Cloudflare is connected through OAuth and saved locally in ~/.insforge/cloudflare.json:

npx @insforge/cli domains cloudflare login
npx @insforge/cli domains cloudflare login --account-id <cloudflare-account-id>  # skip account selection

The CLI opens Cloudflare in the browser, receives the OAuth callback on http://127.0.0.1:8787/callback, stores the returned Cloudflare tokens locally, and discovers the Cloudflare account selected during authorization. For non-browser environments, pass --skip-browser and open the printed URL manually. CLOUDFLARE_ACCOUNT_ID / CLOUDFLARE_ACCESS_TOKEN can override the local OAuth credentials for automation.

Use the split commands when you want to inspect or resume a workflow:

npx @insforge/cli domains search my-app
npx @insforge/cli domains search my-app --tlds com,app,dev   # optional local filter
npx @insforge/cli domains check my-app.dev
npx @insforge/cli domains buy my-app.dev
npx @insforge/cli domains attach my-app.dev
npx @insforge/cli domains dns sync my-app.dev
npx @insforge/cli domains verify my-app.dev
npx @insforge/cli domains status my-app.dev --cloudflare

Cloudflare only allows programmatic registration for TLDs currently supported by its Registrar API. The CLI surfaces Cloudflare's availability reason when a TLD is dashboard-only or not supported by the API.

For agent runs, use explicit purchase confirmations. The global --yes flag does not bypass domain purchase confirmation:

npx @insforge/cli domains buy-and-attach my-app.dev \
  --confirm-domain my-app.dev \
  --confirm-price 10.11 \
  --confirm-currency USD \
  --confirm-cloudflare-billing \
  --confirm-non-refundable \
  --json

If Cloudflare registration is still in progress, retry with:

npx @insforge/cli domains resume my-app.dev

Payments — `npx @insforge/cli payments`

Manage the payments foundation for the linked InsForge project. Provider-specific commands live under payments stripe and payments razorpay. These commands are intended for developers and agents configuring provider keys, syncing mirrored provider state, inspecting customers, and managing provider catalog records. Runtime checkout/order/subscription calls should usually be made from the app via the SDK.

`npx @insforge/cli payments <provider> status`

Show key, account, sync, and webhook status for test/live environments.

npx @insforge/cli payments stripe status
npx @insforge/cli payments razorpay status
npx @insforge/cli payments stripe status --json

`npx @insforge/cli payments <provider> config`

Set or remove provider keys. config set validates the keys and automatically syncs provider state when the key or account changes. Use payments <provider> status to inspect key, account, sync, and webhook health.

npx @insforge/cli payments stripe config set --environment test sk_test_xxx
npx @insforge/cli payments stripe config set --environment live        # prompts securely
npx @insforge/cli payments stripe config remove --environment test -y
npx @insforge/cli payments razorpay config set --environment test --key-id rzp_test_xxx --key-secret xxx
npx @insforge/cli payments razorpay config remove --environment test -y

`npx @insforge/cli payments <provider> sync`

Manually refresh or retry provider catalog, customers, subscriptions, and transaction projections from configured environments. config set already syncs automatically when keys or accounts change.

npx @insforge/cli payments stripe sync
npx @insforge/cli payments stripe sync --environment test
npx @insforge/cli payments razorpay sync --environment test
npx @insforge/cli payments stripe sync --environment live --json

`npx @insforge/cli payments stripe webhooks configure --environment <environment>`

Create or recreate the InsForge-managed Stripe webhook endpoint for an environment.

npx @insforge/cli payments stripe webhooks configure --environment test

Razorpay webhook setup

Razorpay webhooks are configured manually in the Razorpay dashboard. Use the InsForge dashboard payments settings dialog to copy the webhook URL and webhook secret, then select the recommended events on Razorpay's website.

`npx @insforge/cli payments <provider> catalog --environment <environment>`

Inspect mirrored provider catalog records for one environment.

npx @insforge/cli payments stripe catalog --environment test
npx @insforge/cli payments razorpay catalog --environment test
npx @insforge/cli payments stripe catalog --environment test --json

`npx @insforge/cli payments <provider> customers --environment <environment>`

List mirrored provider customers for admin/debugging workflows.

npx @insforge/cli payments stripe customers --environment test
npx @insforge/cli payments razorpay customers --environment test
npx @insforge/cli payments stripe customers --environment test --limit 20 --json

`npx @insforge/cli payments stripe products`

List, inspect, create, update, or delete Stripe products.

npx @insforge/cli payments stripe products list --environment test
npx @insforge/cli payments stripe products get prod_123 --environment test
npx @insforge/cli payments stripe products create --environment test --name "Pro Plan"
npx @insforge/cli payments stripe products update prod_123 --environment test --description "Updated"
npx @insforge/cli payments stripe products delete prod_123 --environment test -y

`npx @insforge/cli payments stripe prices`

List, inspect, create, update, or archive Stripe prices.

npx @insforge/cli payments stripe prices list --environment test
npx @insforge/cli payments stripe prices create --environment test --product prod_123 --currency usd --unit-amount 2000
npx @insforge/cli payments stripe prices create --environment test --product prod_123 --currency usd --unit-amount 2000 --interval month
npx @insforge/cli payments stripe prices update price_123 --environment test --active false
npx @insforge/cli payments stripe prices archive price_123 --environment test

`npx @insforge/cli payments razorpay items`

List, create, or update Razorpay items.

npx @insforge/cli payments razorpay items list --environment test
npx @insforge/cli payments razorpay items create --environment test --name "Pro Plan" --amount 200000 --currency inr
npx @insforge/cli payments razorpay items update item_123 --environment test --active false

`npx @insforge/cli payments razorpay plans`

List or create Razorpay subscription plans.

npx @insforge/cli payments razorpay plans list --environment test
npx @insforge/cli payments razorpay plans create --environment test --period monthly --interval 1 --item-name "Pro Plan" --item-amount 200000 --item-currency inr

Use --notes '{"key":"value"}' when the Razorpay Plan needs native Razorpay notes.

`npx @insforge/cli payments <provider> subscriptions --environment <environment>`

List mirrored provider subscriptions for admin/debugging workflows.

npx @insforge/cli payments stripe subscriptions --environment test
npx @insforge/cli payments razorpay subscriptions --environment test
npx @insforge/cli payments stripe subscriptions --environment test --subject-type team --subject-id team_123

`npx @insforge/cli payments <provider> transactions --environment <environment>`

List mirrored payment transactions for admin/debugging workflows. --subject-type and --subject-id refer to the app billing subject passed to InsForge, such as team:team_123 or user:user_123; they are not provider customer, payment, order, or subscription ids.

npx @insforge/cli payments stripe transactions --environment test
npx @insforge/cli payments razorpay transactions --environment test
npx @insforge/cli payments stripe transactions --environment test --limit 20 --json

Secrets — `npx @insforge/cli secrets`

`npx @insforge/cli secrets list`

List all secrets (metadata only, values are hidden). Inactive (deleted) secrets are hidden by default.

npx @insforge/cli secrets list
npx @insforge/cli secrets list --all   # include inactive secrets
npx @insforge/cli secrets list --json

`npx @insforge/cli secrets get <key>`

Get the decrypted value of a secret.

npx @insforge/cli secrets get STRIPE_API_KEY
npx @insforge/cli secrets get STRIPE_API_KEY --json

`npx @insforge/cli secrets add <key> <value>`

Create a new secret.

npx @insforge/cli secrets add STRIPE_API_KEY sk_live_xxx
npx @insforge/cli secrets add STRIPE_API_KEY sk_live_xxx --reserved
npx @insforge/cli secrets add TEMP_TOKEN abc123 --expires "2025-12-31T00:00:00Z"

`npx @insforge/cli secrets update <key>`

Update an existing secret.

npx @insforge/cli secrets update STRIPE_API_KEY --value sk_live_new_xxx
npx @insforge/cli secrets update STRIPE_API_KEY --active false
npx @insforge/cli secrets update STRIPE_API_KEY --reserved true
npx @insforge/cli secrets update STRIPE_API_KEY --expires null   # remove expiration

`npx @insforge/cli secrets delete <key>`

Delete a secret (soft delete — marks as inactive).

npx @insforge/cli secrets delete STRIPE_API_KEY
npx @insforge/cli secrets delete STRIPE_API_KEY -y   # skip confirmation

Schedules — `npx @insforge/cli schedules`

Manage scheduled tasks (cron jobs).

`npx @insforge/cli schedules list`

List all schedules in the current project.

npx @insforge/cli schedules list
npx @insforge/cli schedules list --json

`npx @insforge/cli schedules create`

Create a new scheduled task.

npx @insforge/cli schedules create --name "daily-cleanup" --cron "0 0 * * *" --url "https://api.example.com/cleanup" --method POST
npx @insforge/cli schedules create --name "hourly-sync" --cron "0 * * * *" --url "https://api.example.com/sync" --method GET --headers '{"Authorization": "Bearer xxx"}'

`npx @insforge/cli schedules get <id>`

Get details of a specific schedule.

npx @insforge/cli schedules get <id>
npx @insforge/cli schedules get 123 --json

`npx @insforge/cli schedules update <id>`

Update an existing schedule.

npx @insforge/cli schedules update <id> --name "weekly-cleanup" --cron "0 0 * * 0"
npx @insforge/cli schedules update 123 --active false

`npx @insforge/cli schedules delete <id>`

Delete a schedule.

npx @insforge/cli schedules delete <id>
npx @insforge/cli schedules delete 123 -y

`npx @insforge/cli schedules logs <id>`

Fetch execution logs for a specific schedule.

npx @insforge/cli schedules logs <id>
npx @insforge/cli schedules logs 123 --limit 100

Compute — `npx @insforge/cli compute`

Manage compute services (Docker containers on Fly.io).

`npx @insforge/cli compute list`

List all compute services.

npx @insforge/cli compute list

`npx @insforge/cli compute get <id>`

Get details of a compute service.

npx @insforge/cli compute get my-api

`npx @insforge/cli compute deploy [dir]`

Deploy a compute service. Source mode runs a flyctl remote build and push (requires flyctl on PATH, no Docker needed); image mode deploys a pre-built image (no flyctl/Docker required).

# Source mode
npx @insforge/cli compute deploy ./api --name my-api
# Image mode
npx @insforge/cli compute deploy --image registry.example.com/my-api:latest --name my-api
# Common options
npx @insforge/cli compute deploy ./api --name my-api \
  --port 8080 --cpu shared-1x --memory 512 --region iad \
  --env '{"LOG_LEVEL":"info"}'        # or --env-file .env

Options:

--name <name>: Service name (required)
--image <url>: Container image URL (image mode)
--port <port>: Container port (default: 8080)
--cpu <tier>: CPU tier (default: shared-1x)
--memory <mb>: Memory in MB (default: 512)
--region <region>: Deploy region (default: iad)
--env <json>: Environment variables as JSON
--env-file <path>: Load environment variables from a file
--protocol <http|tcp>: Service protocol (default: http)

`npx @insforge/cli compute update <id>`

Update a compute service.

npx @insforge/cli compute update my-api --memory 1024
npx @insforge/cli compute update my-api --env-set LOG_LEVEL=debug   # set/update one var (repeatable)
npx @insforge/cli compute update my-api --env-unset OLD_KEY         # remove one var (repeatable)

Options:

--image <image>: Container image URL
--port <port>: Container port
--cpu <tier>: CPU tier
--memory <mb>: Memory in MB
--region <region>: Deploy region
--env <json>: Environment variables as JSON (replaces ALL vars)
--env-set <KEY=VALUE>: Set/update one variable (repeatable, merges)
--env-unset <KEY>: Remove one variable (repeatable, merges)

`npx @insforge/cli compute start <id>` / `stop <id>`

Start a stopped, or stop a running, compute service.

npx @insforge/cli compute start my-api
npx @insforge/cli compute stop my-api

`npx @insforge/cli compute events <id>`

Get compute service machine events (start/stop/exit/restart).

npx @insforge/cli compute events my-api --limit 50

`npx @insforge/cli compute delete <id>`

Delete a compute service and its Fly.io resources.

npx @insforge/cli compute delete my-api

Diagnose — `npx @insforge/cli diagnose`

Backend diagnostics. Run with no subcommand for a full health report.

npx @insforge/cli diagnose
npx @insforge/cli diagnose --ai "why is my database slow?"   # ask AI to analyze diagnostic data

`npx @insforge/cli diagnose advisor`

Display latest advisor scan results and issues.

npx @insforge/cli diagnose advisor --severity critical --category security --limit 50

`npx @insforge/cli diagnose db`

Run database health checks (connections, bloat, index usage, etc.).

npx @insforge/cli diagnose db
npx @insforge/cli diagnose db --check connections,bloat

`npx @insforge/cli diagnose logs`

Aggregate error-level logs from all backend sources.

npx @insforge/cli diagnose logs --source postgres.logs --limit 100

`npx @insforge/cli diagnose metrics`

Display EC2 instance metrics (CPU, memory, disk, network).

npx @insforge/cli diagnose metrics --range 6h

Web Scraper — `npx @insforge/cli webscraper`

Connect a web scraper provider to the linked InsForge project. Provider-specific commands live under webscraper <provider> (Apify is the first provider). These commands are intended for developers and agents who want to scrape or pull external data into a project: connect the account once, then let the local agent run the provider's tools using an InsForge-managed token. Runtime data calls should fetch a fresh token from InsForge rather than embedding a personal key.

`npx @insforge/cli webscraper apify connect`

Connect your Apify account to your InsForge project via OAuth, then automatically run the auth bridge (token login + agent skills) so the local agent is immediately usable.

npx @insforge/cli webscraper apify connect
npx @insforge/cli webscraper apify connect --skip-browser   # only print the OAuth URL, do not auto-open the browser

Authenticate the local Apify CLI/agent using your InsForge-managed token (no browser). Re-run this on any Apify 401/"not logged in" error; InsForge re-fetches a fresh token. Never use the plain apify login browser flow.

npx @insforge/cli webscraper apify login

PostHog — `npx @insforge/cli posthog`

Manage PostHog product analytics integration.

`npx @insforge/cli posthog setup`

Connect PostHog to your InsForge dashboard, then run the official PostHog wizard to wire it into your app.

npx @insforge/cli posthog setup
npx @insforge/cli posthog setup --skip-browser   # only print the OAuth URL, do not auto-open the browser

Config — `npx @insforge/cli config`

Manage insforge.toml (declarative project configuration).

`npx @insforge/cli config export`

Pull live project config and write insforge.toml.

npx @insforge/cli config export
npx @insforge/cli config export --out insforge.toml --force

`npx @insforge/cli config plan`

Show the diff between insforge.toml and live project state.

npx @insforge/cli config plan
npx @insforge/cli config plan --file insforge.toml

`npx @insforge/cli config apply`

Apply insforge.toml to the live project.

npx @insforge/cli config apply
npx @insforge/cli config apply --dry-run        # show plan, do not apply
npx @insforge/cli config apply --auto-approve   # skip confirmation prompt

Project Configuration

Running npx @insforge/cli link creates a .insforge/ directory in your project:

.insforge/
└── project.json    # project_id, org_id, appkey, region, api_key, oss_host

Add .insforge/ to your .gitignore — it contains your project API key.

Declarative project config — `insforge.toml`

Use config export, config plan, and config apply to manage project settings through insforge.toml:

npx @insforge/cli config export --out insforge.toml
npx @insforge/cli config plan --file insforge.toml
npx @insforge/cli config apply --file insforge.toml --auto-approve

Supported TOML sections include auth redirects and verification flags, password policy, SMTP, storage upload size, realtime/schedule retention, and cloud deployment subdomain:

[auth]
allowed_redirect_urls = ["https://app.example.com"]
require_email_verification = true
verify_email_method = "link"
reset_password_method = "code"
disable_signup = false

[auth.password]
min_length = 12
require_number = true
require_lowercase = true
require_uppercase = false
require_special_char = true

[auth.smtp]
enabled = true
host = "smtp.example.com"
port = 587
username = "mailer@example.com"
password = "env(SMTP_PASSWORD)"
sender_email = "noreply@example.com"
sender_name = "Example"
min_interval_seconds = 60

[storage]
max_file_size_mb = 100

[realtime]
retention_days = 7

[schedules]
retention_days = 0 # 0 disables retention cleanup

[deployments]
subdomain = "my-app"

config apply uses backend admin APIs and skips sections that the connected backend version does not expose. It does not manage external provider resources such as OAuth apps, storage bucket lifecycle, realtime channels, deployment environment variables, functions, or secrets.

Global configuration is stored in ~/.insforge/:

~/.insforge/
├── credentials.json    # access_token, refresh_token, user profile
└── config.json         # default_org_id, platform_api_url

Agent Skills

When you run npx @insforge/cli create or npx @insforge/cli link, the CLI automatically installs a set of InsForge agent skills into your project for all supported AI coding agents (Claude Code, Cursor, Windsurf, Cline, Roo, Gemini CLI, GitHub Copilot, Qwen, Qoder, Trae, Kilo, Codex, Augment, Antigravity). These skills teach your coding agent how to work with InsForge — database queries, auth, storage, edge functions, realtime, etc. — so it can generate correct code for your backend without you copy-pasting docs.

It also installs find-skills so agents can discover available skills on demand.

Skill files are written to per-agent directories (e.g. .claude/, .cursor/, .windsurf/) and are automatically added to your .gitignore. You can re-run npx @insforge/cli link at any time to reinstall or update skills.

For bare agent harnesses that follow the open agents.md standard (a single AGENTS.md at the project root) rather than the per-agent skill directories, the CLI also writes an AGENTS.md into your project. It contains a delimited … block with InsForge context (where credentials live, when to reach for the SDK vs. the CLI, and a few correctness patterns). If you already have an AGENTS.md, the block is appended once and refreshed in place on subsequent runs, leaving your own content untouched. Unlike the per-agent skill files, AGENTS.md is not gitignored, so you can commit and share it.

Analytics

The CLI reports anonymous usage events to PostHog so we can understand which features are being used and prioritize improvements.

We capture only non-sensitive metadata: the command name, subcommand, outcome (success, applied, aborted, dry_run, no_changes, all_skipped, error), flag shape (e.g. dry_run, json_mode), section names from insforge.toml schema (e.g. auth.smtp), region, and an OSS-vs-cloud flag. We never send SQL, TOML file contents, credentials, environment variable values, or any free text you type.

If you build the CLI from source without setting POSTHOG_API_KEY at build time, analytics become a no-op automatically.

Environment Variables

Variable	Description
`INSFORGE_ACCESS_TOKEN`	Override the stored access token
`INSFORGE_PROJECT_ID`	Override the linked project ID
`INSFORGE_API_URL`	Override the Platform API URL
`INSFORGE_EMAIL`	Email for non-interactive login
`INSFORGE_PASSWORD`	Password for non-interactive login

Non-Interactive / CI Usage

All commands support --json for structured output and -y to skip confirmation prompts:

# Login in CI
INSFORGE_EMAIL=$EMAIL INSFORGE_PASSWORD=$PASSWORD npx @insforge/cli login --email --json

# Link a project
npx @insforge/cli link --project-id $PROJECT_ID --org-id $ORG_ID -y

# Query and pipe results
npx @insforge/cli db query "SELECT * FROM users" --json | jq '.rows[].email'

# Deploy frontend
npx @insforge/cli deployments deploy ./dist --json

# Upload a build artifact
npx @insforge/cli storage upload ./dist/bundle.js --bucket assets --key "v1.2.0/bundle.js" --json

Exit Codes

Code	Meaning
0	Success
1	General error
2	Authentication failure
3	Project not linked (run `npx @insforge/cli link` first)
4	Resource not found
5	Permission denied

Development

git clone <repo-url>
cd insforge-CLI
npm install
npm run build
npm link        # makes `insforge` available globally

npm run dev     # watch mode for development

Testing

Unit tests

npm run test:unit

Real project integration tests

Run locally:

INTEGRATION_TEST_ENABLED=true \
INTEGRATION_LOG_SOURCE=insforge.logs \
npm run test:integration:real

Prerequisites:

Logged in (npx @insforge/cli login) so ~/.insforge/credentials.json exists
Linked project in this repo (npx @insforge/cli link) so .insforge/project.json exists

Optional environment variables:

INSFORGE_API_URL: Platform API URL override (defaults to https://api.insforge.dev)
INTEGRATION_LOG_SOURCE: Log source for logs test (default insforge.logs)

Current real-project checks:

whoami --json
metadata --json
logs <source> --json
docs instructions --json

Releasing

Bump the version, push the tag, and create a GitHub Release — the CI will publish to npm automatically.

# Bump version (creates commit + tag)
npm version patch   # 0.1.3 → 0.1.4
# or
npm version minor   # 0.1.3 → 0.2.0

# Push commit and tag
git push && git push --tags

Then go to GitHub → Releases → Draft a new release, select the tag (e.g. v0.1.4), and publish. The publish workflow will run npm publish automatically.

License

Apache-2.0

Keywords

insforge cli backend database storage functions