Skip to main content

​
CLI Reference

This page is the fast orientation guide for si. For a full categorized list, use Command Reference.

​
Command discovery pattern

si --help
si <command> --help
si <command> <subcommand> --help

​
CLI color system

SI text output uses a small semantic palette instead of per-command ad hoc colors:
RoleMeaningColor
Section headingsusage blocks, help sections, command-group titlescyan
Commands and examplescommand names, runnable examples, selected profilesmagenta
Flags and operator promptsoptions, warnings, confirmation promptsyellow
Labelskey=value keys, field names, probe labelsblue
Successready, ok, warmed, healthy stategreen
Warningdegraded or operator-attention stateyellow
Errorfailed, invalid, destructive/error statered
Mutedindexes, separators, filler textgray
Rules:
  • JSON output stays uncolored.
  • Text output uses the semantic palette above when color is enabled.
  • si --help and nested --help output use the same palette as runtime text output.
Color control:
  • SI_CLI_COLOR=always: force color even when stdout is not a TTY
  • SI_CLI_COLOR=auto: default behavior
  • SI_CLI_COLOR=never: disable CLI colors
  • NO_COLOR=1: disable CLI colors

​
Top-level command families

DomainCommands
Runtime and orchestrationsi codex, si surf, si viva
Secrets and contextsi vault (si creds), si fort, si settings
Provider orbitssi orbit github, si orbit cloudflare, si orbit gcp, si orbit aws, si orbit openai, si orbit oci, si orbit google, si orbit workos, si orbit apple, si orbit stripe, si image
Build and releasesi build, si commands, si version, si help

​
High-signal workflows

​
Runtime setup

si build image
si codex spawn --profile default --workspace "$PWD"
si codex list

​
Viva tunnel via SI wrapper

si viva config set --repo ~/Development/viva --build true
si viva config tunnel show --json
si viva -- tunnel up --profile dev
si viva -- tunnel status --profile dev
si viva -- tunnel down --profile dev

​
Integration readiness

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

​
Fort runtime secret check

si fort doctor
si fort get --repo releasemind --env dev --key RM_OPENAI_API_KEY

​
Release 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
  • si orbit github release create now verifies the remote tag first.
  • When the tag is missing, pass --target <sha> and SI will create the git tag ref before creating the release.
  • For draft releases, GitHub may still return an untagged-... HTML URL until publish; verify with tag_name and git ls-remote --tags.

​
Faster Rust iteration

si build self check --timings
si build self --timings
  • si build self now reuses .artifacts/cargo-target/self-build by default for faster rebuilds.
  • si build self check runs cargo check against the SI CLI manifest without linking a release binary.
  • si build self and release-asset builds auto-use sccache when it is available on PATH.

​
Safety guidance

  • On host/admin flows, use si vault run -- <command> when secrets are required.
  • In SI runtime containers, use si fort ... for secret access.
  • si fort wrapper passes explicit Fort file-path auth flags when defaults are available: --host from settings and --token-file from ~/.si/fort/bootstrap/admin.token.
  • If a flag belongs to the native fort CLI, pass it after -- (example: si fort -- --host https://fort.aureuma.ai doctor).
  • Prefer --json for automation and auditability.
  • Run doctor commands before mutating production systems.
  • Keep command docs aligned with si --help and si help --format json.