Syndroodocs
Version0.6.0-rc.1unpublished release candidateWebsiteGitHub

Local command reference

Every command below belongs to the local path and needs no server. syndroo help prints usage, and syndroo <command> --help prints the flags for one command.

Commands

CommandWhat it does
syndroo init [--namespace <name>]Create the local config and state. Repeats safely with the same namespace.
syndroo doctor --localCheck config, state and bindings. Read-only, no network.
syndroo providers listList the local providers with maturity and availability.
syndroo auth set <provider> --localVerify one account and register a credential reference.
syndroo auth status [<provider>] --localShow the bindings. Offline unless --verify is added.
syndroo auth remove <provider> --localRemove one binding and keep a tombstone.
syndroo publish --input <path|-> --dry-runFreeze a plan and print it. The only way to start a local publish.
syndroo publish --plan <plan-id>Execute one frozen plan.
syndroo receipts listList recent local operations, newest first; default 20.
syndroo receipts show <operation-id>Show one operation with its per-target records.
syndroo retry <operation-id> --to <csv> --dry-runFreeze a retry plan for explicitly selected safe targets.
syndroo retry --plan <plan-id>Execute one frozen retry plan.
syndroo state inspectShow lock, versions and defects. Never repairs.
syndroo state recover --confirm-no-writers --yesRecover after every other writer has stopped.
syndroo skill pathPrint the absolute path of the bundled Skill directory.
syndroo help, syndroo versionPrint usage or the CLI version. Neither touches the network.

Flags

  • --json writes exactly one object to stdout and sends every diagnostic, including the preview, to stderr.
  • --local selects the local path for doctor and the auth commands.
  • --state-home <path> and --namespace <name> override the state location and deduplication domain for one run.
  • --yes confirms without a prompt and --no-input never prompts; a non-interactive run needs both.
  • --from-env or --credential-file <path> chooses the credential source, and --expect-account <id> pins the account a non-interactive run verified.
  • --verify re-checks an identity over the network without changing the binding.
  • --input <path|->, --plan <plan-id> and --to <csv> name the document, a frozen plan, and retry targets.
  • --confirm-no-writers is the recovery confirmation, --limit <n> bounds a listing, and --timeout <duration> bounds an execution or an explicit verification.

Exit codes

CodeMeaning
0The command finished: a plan was written, a read succeeded, or a run fully succeeded.
1Local I/O or runtime failure, or a trusted success that could not be persisted.
2Admission failure: usage, config, document, confirmation or binding. No content request.
4An unknown write result. Read the receipt before doing anything else.
5The operator declined before any content request.
6The run ended without full delivery.
130The process stopped on a signal. An in-flight write is not cancelled.

The local surface does not return exit 3.

Short examples

syndroo publish --input post.json --dry-run --json
syndroo publish --plan <result.planId> --yes --no-input --json
syndroo receipts show <result.operationId> --json
syndroo retry <result.operationId> --to threads --dry-run --json

With --json, stdout carries one envelope: {schemaVersion, command, mode, ok, result, error}. Read result.status as well as the exit code, because a preview can be ok while nothing was published.

Next steps