CLI reference

All commands read credentials from .env.local; to override, pass the global flags before the command (result --url <url> --key <key> <command>). Run result <command> --help for full flags.

init

result init

Verifies credentials, persists backend rules into AGENTS.md/CLAUDE.md. Idempotent - re-run any time.

status

result status

Tables (with row counts), buckets, functions and auth at a glance. Run this before creating anything - it may already exist.

db

result db tables                 # list tables
result db schema posts           # one table's columns as JSON

db create-table

result db create-table posts \
  -c "title:string:required" \
  -c "user_id:uuid"

Column spec: name:type[:required][:unique]
Types: string, integer, float, boolean, datetime, date, json, uuid
id, created_at, updated_at are added automatically - never spec them
RLS is on by default. With a user_id uuid column the owner policy is created automatically (rows scoped to the signed-in user, user_id defaults from the session; --no-policy skips it). Without one the command warns: an RLS table with no policy denies all reads and writes. --no-rls for shared/public data.

db migrate

result db migrate --name add-posts-index --sql "CREATE INDEX idx_posts_title ON posts (title);"
result db migrate --name setup-pgvector --file ./migration.sql

Raw SQL for anything create-table can’t express: indexes, custom RLS policies, triggers, extensions (pgvector). Versioning is automatic; the migration already runs in one transaction, so never write BEGIN/COMMIT.

result db migrations             # list applied migrations

storage

result storage buckets
result storage create-bucket uploads              # public: files get stable URLs
result storage create-bucket private-docs --private   # private: use signed URLs

realtime

result realtime channels
result realtime add-channel "chat:%" --description "chat rooms"

% is a wildcard - chat:% covers chat:room-1, chat:room-2, etc. Clients cannot subscribe until a pattern covers the channel.

functions

result functions list
result functions deploy my-fn --file fn.ts    # creates, or updates if it exists

The function runs at $NEXT_PUBLIC_BACKEND_URL/functions/my-fn.

secrets

result secrets list                  # your keys only, values never shown
result secrets set OPENWEATHER_KEY=... SLACK_WEBHOOK_URL=...

Read inside functions with Deno.env.get("OPENWEATHER_KEY"). Treat secrets as permanent - deletion is unreliable on current backend versions.

deployments

result deployments deploy [dir]      # upload source, build remotely, go live
result deployments list              # history
result deployments status <id>       # one deploy, with its error if it failed
result deployments cancel <id>       # stop a build still in progress
result deployments env list          # build variables, values never shown
result deployments env set KEY=value # applies from the next deploy
result deployments env delete <id>   # id from env list

Deploys the frontend to Result hosting. node_modules, .git, build output and .env* files never upload. Because env files stay home, set NEXT_PUBLIC_BACKEND_URL and NEXT_PUBLIC_BACKEND_ANON_KEY as build variables before the first deploy; never set BACKEND_ADMIN_KEY there. deploy --env KEY=value saves the variable and applies it to that build. The command polls up to 5 minutes and prints the live URL; history and status also live in the dashboard under Infrastructure, Deployments.

auth

result auth users                    # admin view of signed-up users

logs

result logs                          # list sources
result logs backend.logs --limit 20  # read one source

Getting started

SDK

CLI

Guides

init

status

db

db create-table

db migrate

storage

realtime

functions

secrets

deployments

auth

logs

​init

​status

​db

​db create-table

​db migrate

​storage

​realtime

​functions

​secrets

​deployments

​auth

​logs

init

status

db

db create-table

db migrate

storage

realtime

functions

secrets

deployments

auth

logs