Skip to main content
Version:

Using Syndicate Code

Everything you need to work with Syndicate Code day-to-day: the TUI, CLI, sessions, workflows, checkpoints, and specialists.

The TUI

The primary interface is a five-pane terminal UI launched by running syndicate with no arguments. It renders governance state pushed from the control plane and surfaces pending checkpoint decisions for operator review.

The TUI has no authority — it is a read and intent surface. Policy enforcement happens at the control plane, not the UI.

The CLI

syndicate is also a CLI for session management, policy operations, audit queries, and headless workflow execution:

syndicate run --no-tui --objective "summarize dependency drift" --output json
syndicate audit verify
syndicate policy show

See CLI for the full command surface, or CLI Reference for exhaustive flag and exit-code documentation.

Sessions, workflows, and checkpoints

Every interaction is scoped to a session. Within a session, the model submits proposals that traverse the governed execution lifecycle. When policy requires operator input, a checkpoint is surfaced in the TUI.

The operator responds (o/y for once, s for session, p for policy, n to deny, d for detail) — the TUI forwards the decision to the control plane, which records the approval, issues or reuses the authorization record, and resumes execution.

Request observability

Request observability links the governed checkpoint flow to downstream gateway execution evidence through a shared request_id.

Operators can use this to move from a checkpoint or support report to the exact gateway trace for a single request instead of searching raw logs by time window.

In this section

  • TUI — five-pane layout, keyboard bindings, authority model
  • CLI — command surface, flags, headless usage
  • Sessions — session lifecycle, attach, inspect, export
  • Workflows — workflow entry point, autonomy modes, dry run
  • Checkpoints — checkpoint types, presentation, invariants
  • Request Observability — request IDs, gateway telemetry, GraphQL correlation, and CLI lookup
  • Specialists — registering and managing specialist agents