Skip to main content

Command Reference

Use this page as the canonical command map for si.

Command discovery workflow

si --help
si <command> --help
si <command> <subcommand> --help
Color semantics for help and text-mode output are documented in CLI Reference. JSON output remains uncolored by design.

Core runtime commands

Command familyPrimary purposeMajor subcommandsDetailed guide
si codexManage profile-bound Codex containers and profile registry stateprofile, spawn, remove, tail, shell, list, tmux, warmup, respawnCLI Reference
si vault (si creds)Encrypt and inject dotenv secretskeypair, status, check, hooks, encrypt, decrypt, restore, set, unset, get, list, run, docker execVault
si fortWrapper for hosted Fort policy/auth API (runtime secret access path)doctor, auth, get, set, list, batch-get, run, agent, config show, config setVault
si surfDockerized Playwright MCP runtimebuild, start, status, logs, proxyBrowser
si vivaManage Viva runtime and node helper commandsconfig, passthrough runtime helpersCLI Reference
si orbitFirst-party provider orbit namespacelist, github, cloudflare, aws, gcp, google, openai, oci, stripe, workos, appleProviders
si imageImage provider and generation bridgeprovider-specific image flowsProviders
si settingsShow resolved SI settingsnoneCLI Reference
si commandsList visible SI root commandslistCLI Reference

Provider and integration command families

IntegrationCommand familyTypical first checksDetailed guide
GitHubsi orbit github ...si orbit github auth status, si orbit github doctor, si orbit github project list AureumaGitHub
Cloudflaresi orbit cloudflare ...si orbit cloudflare auth status, si orbit cloudflare doctorCloudflare
GCP + Gemini/Vertexsi orbit gcp ...si orbit gcp auth status, si orbit gcp doctorGCP
Google Placessi orbit google places ...si orbit google places auth status, si orbit google places doctorGoogle Places
Google Playsi orbit google play ...si orbit google play auth status, si orbit google play doctorGoogle Play
YouTube Datasi orbit google youtube ...si orbit google youtube auth status, si orbit google youtube doctorGoogle YouTube
AWSsi orbit aws ...si orbit aws auth status, si orbit aws doctorAWS
OpenAIsi orbit openai ...si orbit openai auth status, si orbit openai doctorOpenAI
OCIsi orbit oci ...si orbit oci auth status, si orbit oci doctorOCI
Stripesi orbit stripe ...si orbit stripe auth status, si orbit stripe doctorStripe
WorkOSsi orbit workos ...si orbit workos auth status, si orbit workos doctorWorkOS
Apple App Store Connectsi orbit apple store ...si orbit apple store auth status, doctorApple App Store
Provider inventorysi orbit listsi orbit list, si orbit list --provider github --jsonProviders

Build, docs, and developer tooling

Command familyPurposeTypical usage
si build imageBuild local runtime imagesi build image
si build selfBuild or upgrade si binarysi build self
si build self checkFast typecheck for the SI CLIsi build self check --timings
si build self assetsBuild all release archives + checksums.txt locallysi build self assets --version vX.Y.Z
si commandsShow visible public root commandssi commands
si settingsInspect resolved settingssi settings

1. New machine bootstrap

si build self
si build self check --timings
si vault status
si --help
si commands

2. Integration readiness check

si orbit list --json
si orbit github doctor --json
si orbit cloudflare doctor --json

3. Release maintainer preflight

si build self assets --version vX.Y.Z --out-dir .artifacts/release-preflight
si orbit github release create Aureuma/si --tag vX.Y.Z --title "vX.Y.Z" --target "$(git rev-parse HEAD)" --draft
  • Use --target <sha> when creating a release for a tag that does not already exist on the remote.
  • SI creates the tag ref first in that case; if --target is omitted, release creation fails clearly.

Guardrails

  • For host/admin automation, prefer si vault run -- <cmd> when a command needs secrets.
  • For SI runtime containers, use si fort ... for secret access.
  • si fort bootstrap/admin auth is file-backed and prefers explicit --token-file injection from ~/.si/fort/bootstrap/admin.token when present.
  • Pass native fort flags after -- when invoking through wrapper.
  • Run integration-specific doctor commands before write operations.
  • Run si help --format json or si commands when updating CLI docs.