--json

-y, --yes

All examples below use

npx @insforge/cli

. Never call

insforge

directly.

• npx @insforge/cli login

  — OAuth (browser) or

  --email

  for password login. See references/login.md

• npx @insforge/cli logout

  — clear stored credentials

• npx @insforge/cli whoami

  — show current user

• npx @insforge/cli create

  — create new project. See references/create.md

• npx @insforge/cli link

  — link directory to existing project

• npx @insforge/cli current

  — show current user + linked project

• npx @insforge/cli list

  — list all orgs and projects

• npx @insforge/cli metadata

  — show backend metadata (auth config, database tables, storage buckets, edge functions, AI models, realtime channels). Use

  --json

  for structured output. Run this first to discover what's configured before building features.

• npx @insforge/cli db query <sql>

  — execute raw SQL. See references/db-query.md

• npx @insforge/cli db tables / indexes / policies / triggers / functions

  — inspect schema

• npx @insforge/cli db rpc <fn> [--data <json>]

  — call database function (GET if no data, POST if data)

• npx @insforge/cli db export

  — export schema/data. See references/db-export.md

• npx @insforge/cli db import <file>

  — import from SQL file. See references/db-import.md

• npx @insforge/cli functions list

  — list deployed functions

• npx @insforge/cli functions code <slug>

  — view function source

• npx @insforge/cli functions deploy <slug>

  — deploy or update. See references/functions-deploy.md

• npx @insforge/cli functions invoke <slug> [--data <json>] [--method GET|POST]

  — invoke function

• npx @insforge/cli functions delete <slug>

  — delete an edge function (with confirmation)

• npx @insforge/cli storage buckets

  — list buckets

• npx @insforge/cli storage create-bucket <name> [--private]

  — create bucket (default: public)

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

  — delete bucket and all its objects (destructive)

• npx @insforge/cli storage list-objects <bucket> [--prefix] [--search] [--limit] [--sort]

  — list objects

• npx @insforge/cli storage upload <file> --bucket <name> [--key <objectKey>]

  — upload file

• npx @insforge/cli storage download <objectKey> --bucket <name> [--output <path>]

  — download file

• npx @insforge/cli deployments deploy [dir]

  — deploy frontend app. See references/deployments-deploy.md

• npx @insforge/cli deployments list

  — list deployments

• npx @insforge/cli deployments status <id> [--sync]

  — get deployment status (--sync fetches from Vercel)

• npx @insforge/cli deployments cancel <id>

  — cancel running deployment

• npx @insforge/cli secrets list [--all]

  — list secrets (values hidden;

  --all

  includes deleted)

• npx @insforge/cli secrets get <key>

  — get decrypted value

• npx @insforge/cli secrets add <key> <value> [--reserved] [--expires <ISO date>]

  — create secret

• npx @insforge/cli secrets update <key> [--value] [--active] [--reserved] [--expires]

  — update secret

• npx @insforge/cli secrets delete <key>

  — soft delete (marks inactive; restore with

  --active true

  )

• npx @insforge/cli schedules list

  — list all scheduled tasks (shows ID, name, cron, URL, method, active, next run)

• npx @insforge/cli schedules get <id>

  — get schedule details

• npx @insforge/cli schedules create --name --cron --url --method [--headers <json>] [--body <json>]

  — create a cron job (5-field cron format only)

• npx @insforge/cli schedules update <id> [--name] [--cron] [--url] [--method] [--headers] [--body] [--active]

  — update schedule

• npx @insforge/cli schedules delete <id>

  — delete schedule (with confirmation)

• npx @insforge/cli schedules logs <id> [--limit] [--offset]

  — view execution logs

• npx @insforge/cli diagnose

  — full health report (runs all diagnostics)

• npx @insforge/cli diagnose metrics [--range 1h|6h|24h|7d] [--metrics <list>]

  — EC2 instance metrics (CPU, memory, disk, network). Default range:

  1h

• npx @insforge/cli diagnose advisor [--severity critical|warning|info] [--category security|performance|health] [--limit <n>]

  — latest advisor scan results and issues. Default limit: 50

• npx @insforge/cli diagnose db [--check <checks>]

  — database health checks. Checks:

  connections

  ,

  slow-queries

  ,

  bloat

  ,

  size

  ,

  index-usage

  ,

  locks

  ,

  cache-hit

  (default:

  all

  )

• npx @insforge/cli diagnose logs [--source <name>] [--limit <n>]

  — aggregate error-level logs from all backend sources. Default limit: 100

• npx @insforge/cli logs <source> [--limit <n>]

  — fetch backend container logs (default: 20 entries)

insforge.logs

postgREST.logs

postgres.logs

function.logs

Source names are case-insensitive:

postgrest.logs

works the same as

postgREST.logs

.

• npx @insforge/cli docs

  — list all topics

• npx @insforge/cli docs instructions

  — setup guide

• npx @insforge/cli docs <feature> <language>

  — feature docs (

  db / storage / functions / auth / ai / realtime

  ×

  typescript / swift / kotlin / rest-api

  )

For writing application code with the InsForge SDK, use the insforge (SDK) skill instead, and use the

npx @insforge/cli docs <feature> <language>

to get specific SDK documentation.

npx @insforge/cli db query "CREATE TABLE posts (
  id UUID DEFAULT gen_random_uuid() PRIMARY KEY,
  title TEXT NOT NULL,
  content TEXT,
  author_id UUID REFERENCES auth.users(id),
  created_at TIMESTAMPTZ DEFAULT now()
)"
npx @insforge/cli db query "ALTER TABLE posts ENABLE ROW LEVEL SECURITY"
npx @insforge/cli db query "CREATE POLICY \"public_read\" ON posts FOR SELECT USING (true)"
npx @insforge/cli db query "CREATE POLICY \"owner_write\" ON posts FOR INSERT WITH CHECK (auth.uid() = author_id)"

FK to users: always

auth.users(id)

. RLS current user:

auth.uid()

.

1. Use 5-field cron expressions only
   • pg_cron does not support seconds (6-field format)
   • Example:

     */5 * * * *

     for every 5 minutes
2. Store sensitive values as secrets
   • Use

     ${{secrets.KEY_NAME}}

     in headers for API keys and tokens
   • Create secrets first via the secrets API before referencing them
3. Target InsForge functions for serverless tasks
   • Use the function URL format:

     https://your-project.region.insforge.app/functions/{slug}

   • Ensure the target function exists and has

     status: "active"

4. Monitor execution logs
   • Check logs regularly to ensure schedules are running successfully
   • Look for non-200 status codes and failed executions

1. Start with function.logs for function issues
   • Check execution errors, timeouts, and runtime exceptions
2. Use postgres.logs for query problems
   • Debug slow queries, constraint violations, connection issues
3. Check insforge.logs for API errors
   • Authentication failures, request validation, general backend errors

create

link

.insforge/project.json

{
  "project_id": "...",
  "appkey": "...",
  "region": "us-east",
  "api_key": "ik_...",
  "oss_host": "https://{appkey}.{region}.insforge.app"
}

oss_host

api_key

Never commit this file to version control or share it publicly. Do not edit this file manually. Use

npx @insforge/cli link

to switch projects.