Documentation
CLI Command Catalog
Generated command and flag catalog for the Syrus CLI.
CLI command catalog
<!-- Generated by bin/surface-catalogs. Do not edit by hand. -->
Generated catalog of commands registered in the Cobra command tree.
| Command | Description | Flags | JSON | ||
|---|---|---|---|---|---|
syrus approve JOB-ID | Approve a Syrus job for landing | --debug, --profile | no | ||
syrus chat CHAT_ID MESSAGE | Send one streaming chat turn | --debug, --profile | no | ||
syrus chat list | List chat sessions | --all, --debug, --json, --profile, --repo | yes | ||
syrus chat new | Create a chat session | --debug, --json, --no-repo, --profile, --repo | yes | ||
| `syrus checkout JOB-ID\ | EPIC-ID\ | BRANCH` | Check out a Syrus Job branch, Epic branch, or plain git branch | --complete, --debug, --no-hooks, --profile | no |
syrus credential | Inspect Credential Store records and run credential wrappers | --debug, --profile | no | ||
syrus credential credentials | List accessible credential handles | --debug, --json, --profile, --type | yes | ||
| `syrus credential exec --credential <credential> --type <type> (--env-var NAME \ | --file-env NAME \ | --stdin) -- <command> [args...]` | Run a command with a brokered credential materialized in one explicit process-local mode | --credential, --debug, --env-var, --expires-in, --file-env, --profile, --purpose, --stdin, --target-json, --tool, --type | no |
syrus credential lease <credential> | Request a scoped runtime broker lease | --debug, --expires-in, --json, --profile, --purpose, --target-json, --tool, --type | yes | ||
syrus credential ssh-agent --credential <credential> -- <command> [args...] | Run a command with a brokered SSH key loaded into a temporary ssh-agent | --credential, --debug, --expires-in, --profile, --purpose, --target-json, --tool | no | ||
syrus credential types | List credential type names | --debug, --json, --profile | yes | ||
syrus docs | Inspect Design Docs | --debug, --profile | no | ||
syrus docs list | List design docs | --debug, --profile, --repo | no | ||
syrus docs show DOC-ID | Show a design doc | --debug, --profile | no | ||
syrus epic | Inspect and manage Syrus epics | --debug, --profile | no | ||
syrus epic create | Create an epic in the current repository | --body, --body-file, --debug, --epic-dependency-policy, --file, --github-issue-url, --profile, --prompt, --repo, --start, --title, --yes | no | ||
syrus epic list | List epics | --debug, --json, --limit, --profile, --repo | yes | ||
syrus epic open EPIC-ID | Open an epic in the default browser | --debug, --profile | no | ||
syrus epic search QUERY | Search epics by title | --debug, --json, --limit, --profile, --repo | yes | ||
syrus epic show EPIC-ID | Show an epic | --debug, --json, --profile | yes | ||
syrus inbox | Review implemented and failed Syrus jobs | --debug, --profile, --repo, --watch | no | ||
syrus insights | Inspect operational insights | --debug, --profile | no | ||
syrus insights spending | Summarize agent spend | --debug, --group-by, --json, --profile, --since, --until | yes | ||
syrus job | Inspect Syrus jobs | --debug, --profile | no | ||
syrus job accept-triage JOB-ID | Accept a triaged job | --debug, --profile | no | ||
syrus job approve JOB-ID | Approve a job for landing | --debug, --profile | no | ||
syrus job cancel JOB-ID | Cancel a job | --debug, --profile | no | ||
syrus job check-mergeability JOB-ID | Check a job pull request's mergeability | --debug, --profile | no | ||
syrus job checkout JOB-ID | Check out a job branch locally | --debug, --no-hooks, --profile | no | ||
syrus job close-investigation JOB-ID | Close a completed investigation job | --debug, --profile | no | ||
syrus job create | Create a direct Syrus job | --agent, --body, --body-file, --debug, --depends-on, --epic, --file, --owner, --priority, --profile, --prompt, --repo, --title, --yes | no | ||
syrus job diagnose JOB-ID --run RUN-ID | Diagnose an active run | --debug, --profile, --run | no | ||
syrus job diff JOB-ID | Show a job pull request diff | --debug, --json, --profile | yes | ||
syrus job list | List jobs | --debug, --json, --limit, --profile, --repo, --state | yes | ||
syrus job log JOB-ID | Show or stream a job transcript | --debug, --json, --profile | yes | ||
syrus job move-to-backlog JOB-ID | Move a job to the backlog | --debug, --profile | no | ||
syrus job open JOB-ID | Open a job in the browser | --debug, --profile | no | ||
syrus job pause JOB-ID | Pause a job | --debug, --profile | no | ||
syrus job push-commits JOB-ID --workflow WORKFLOW-ID | Push pending workflow commits | --debug, --profile, --workflow | no | ||
syrus job rebase JOB-ID | Rebase a job pull request | --debug, --profile | no | ||
syrus job recheck-pr-checks JOB-ID | Recheck a job pull request's checks | --debug, --profile | no | ||
syrus job reject-triage JOB-ID | Reject a triaged job | --debug, --profile | no | ||
syrus job release-from-backlog JOB-ID | Release a job from the backlog | --debug, --profile | no | ||
syrus job reopen JOB-ID | Reopen a closed job | --debug, --profile | no | ||
syrus job resume JOB-ID --source-run RUN-ID | Resume a job from a source run | --debug, --profile, --source-run | no | ||
syrus job retry JOB-ID | Retry a job | --debug, --profile | no | ||
syrus job retry-step JOB-ID --workflow WORKFLOW-ID | Retry a failed workflow step | --debug, --profile, --workflow | no | ||
syrus job search QUERY | Search jobs by title | --debug, --json, --limit, --profile, --repo, --state | yes | ||
syrus job show JOB-ID | Show a job | --debug, --json, --profile | yes | ||
syrus job start JOB-ID | Start a direct job | --debug, --profile | no | ||
syrus job stop-landing JOB-ID | Stop an in-progress landing | --debug, --profile | no | ||
syrus job stop-run JOB-ID --run RUN-ID | Stop an active run | --debug, --profile, --run | no | ||
syrus job test-plan JOB-ID | Show a job test plan | --debug, --profile | no | ||
syrus job unapprove JOB-ID | Remove your job approval | --debug, --profile | no | ||
syrus job unpause JOB-ID | Unpause a job | --debug, --profile | no | ||
syrus job watch JOB-ID | Watch a job | --debug, --json, --profile | yes | ||
syrus jobs | List Syrus jobs | --closed, --debug, --profile, --repo | no | ||
syrus k8s | Inspect registered Kubernetes clusters | --debug, --profile | no | ||
syrus k8s clusters | List registered Kubernetes clusters | --debug, --profile | no | ||
syrus k8s deployments | List deployments | --cluster, --debug, --namespace, --profile | no | ||
syrus k8s events | List recent cluster events | --cluster, --debug, --namespace, --profile | no | ||
syrus k8s logs POD | Show a pod's log tail | --cluster, --container, --debug, --namespace, --profile, --tail | no | ||
syrus k8s namespaces | List namespaces in a cluster | --cluster, --debug, --profile | no | ||
syrus k8s nodes | List cluster nodes | --cluster, --debug, --profile | no | ||
syrus k8s overview | Show aggregate node/pod CPU and memory usage | --cluster, --debug, --profile | no | ||
syrus k8s pods | List pods | --cluster, --debug, --namespace, --profile | no | ||
syrus k8s pvcs | List persistent volume claims | --cluster, --debug, --namespace, --profile | no | ||
syrus k8s services | List services | --cluster, --debug, --namespace, --profile | no | ||
syrus local | Connect this machine to a Syrus Local Mode chat session | --chat, --debug, --dir, --profile, --token | no | ||
syrus login | Log in to a Syrus instance | --debug, --profile, --token, --url | no | ||
syrus repo | Inspect Syrus repositories | --debug, --profile | no | ||
syrus repo list | List repositories | --debug, --json, --profile | yes | ||
syrus review | Review job diffs from scripts | --debug, --profile | no | ||
syrus review add JOB-ID | Add a diff review comment | --body, --debug, --diff-hunk, --line, --new-line, --old-line, --path, --profile, --run-id, --side, --state, --surface, --version, --workflow-id | no | ||
syrus review list JOB-ID | List diff review comments for a job | --all-versions, --debug, --json, --path, --profile, --state, --surface, --version | yes | ||
syrus review reply JOB-ID COMMENT-ID | Reply to a diff review comment thread | --body, --debug, --profile, --version | no | ||
syrus review resolve JOB-ID COMMENT-ID | Resolve a diff review comment thread | --debug, --profile, --version | no | ||
syrus review submit JOB-ID | Submit pending diff review comments as job feedback | --comment-id, --debug, --profile, --version | no | ||
syrus schedule | Manage Syrus schedules | --debug, --profile | no | ||
syrus schedule create | Create a schedule in the current repository | --debug, --profile, --yes | no | ||
syrus schedule delete ID | Delete a schedule | --debug, --profile | no | ||
syrus schedule list | List schedules | --debug, --profile | no | ||
syrus schedule run ID | Run a schedule now | --debug, --profile | no | ||
syrus schedule show ID | Show a schedule | --debug, --profile | no | ||
syrus search <query> | Search Jobs, Epics, and chats | --debug, --json, --limit, --profile, --type | yes | ||
syrus skill | Manage the Claude Code skill for Syrus | --debug, --profile | no | ||
syrus skill install | Install the Syrus skill for Claude Code | --debug, --dir, --profile | no | ||
syrus status | Show which Syrus job is checked out here | --debug, --json, --profile | yes | ||
syrus test-plan [JOB-ID] | Print the latest completed Job test plan | --debug, --profile | no | ||
syrus whoami | Show current Syrus identity | --debug, --json, --profile | yes |