SDKs & integrations

CLI

Bring the day-to-day backend workflow into your terminal and your repo.

The orbitnest CLI handles auth, project linking, versioned SQL migrations, type generation, and integration management — all from the command line.

Install

bash

npm install -g @orbitneststudio/cli
# or run without installing:
npx @orbitneststudio/cli --help

Quickstart

bash

orbitnest login                 # stored in ~/.orbitnest/credentials.json (0600)
orbitnest link my-project       # writes .orbitnest/config.json (safe to commit)
orbitnest migration new "create posts table"
orbitnest db push
orbitnest gen types             # → orbitnest.types.ts

Database & migrations

Migrations are versioned .sql files with an optional -- migrate:down section. See Database for the format.

bash

orbitnest db push               # apply pending migrations
orbitnest db status             # applied / pending / modified
orbitnest db rollback           # roll back the latest (uses -- migrate:down)
orbitnest db reset --yes        # drop all tables + re-apply (destructive)
orbitnest db sql "select 1"     # run ad-hoc SQL (--file <path>)
orbitnest db connect            # print the direct Postgres connection string
orbitnest db diff --save        # snapshot the live schema → .orbitnest/schema.snapshot.json
orbitnest db diff               # show drift vs the snapshot (exits 1 on drift — CI-friendly)

Webhooks & SMS

bash

orbitnest webhooks list
orbitnest webhooks create --url https://example.com/hook --events INSERT,UPDATE
orbitnest webhooks test <id>

orbitnest sms get
orbitnest sms set --sid AC... --token ... --from +15555550123 --enable
orbitnest sms test +15555550123

Files

Credentials live at ~/.orbitnest/credentials.json (mode 0600, shared with the MCP server). The per-directory project link is .orbitnest/config.json and is safe to commit.

Generate types in CI

Wire orbitnest gen types into a predev / prebuild script and commit the output for end-to-end type safety against your live schema.