CLI Reference

Every domain in the suya command surface. All commands accept --json for machine output and --host to target an environment. Run suya <domain> --help for the authoritative flag list.

Global flags

• --json — structured JSON envelope on stdout
• --host <url> — API host (defaults to the baked-in install host)
• --token <t> — override $SUBAYA_API_KEY / stored auth
• -q/--quiet, -v/--verbose, --pretty

auth — authentication

• suya auth login — browser OAuth flow; persists a token
• suya auth logout — clear the stored token
• suya auth whoami — show the active identity

project — projects

• suya project create <name>
• suya project list
• suya project use <id> — set the .subaya/config.toml default

sim — simulation

• suya sim run --project <id> --tb <path> --top <module> [--source <dir>] [--tool ryusim] [--tier S] [--wait]
• suya sim report <run-id> [--wait] — status + results summary
• suya sim list [--project <id>] [--status <s>] [--limit N]
• suya sim logs <run-id> [--follow]
• suya sim rerun <run-id> [--wait]
• suya sim wave <run-id> — locate the waveform (hand off to wf)

hw — hardware validation

• suya hw agent register --name <n> · list · revoke <id> · run
• suya hw run --target <t> [--test-plan <file>]
• suya hw history [--project <id>] [--limit N]

rag — retrieval

• suya rag ingest / query — index and search project knowledge

plan — planning artifacts

• suya plan docs list · show <id> · approve <id>
• suya plan items list · show <id>
• suya plan diagrams list
• suya plan session — print the planner attach hint

repo & device

• suya repo … — connect a GitHub-backed project repo
• suya device … — manage registered devices

session

• suya attach / suya detach — open/close an interactive session pod

Maintenance

• suya version · suya update · suya install

← Back to Getting Started