Skip to main content
SCSyndicate Code
Get Started

Getting Started

Syndicate Code installs as a single binary. After installation, syndicate init initializes your workspace and syndicate launches the TUI with a first-run onboarding wizard.

What you need

  • macOS 13+, Linux (Ubuntu 20.04+), or Windows 10 (1809+)
  • A model provider API key — Anthropic, OpenAI, Google, or a local inference endpoint
  • 4 GB RAM minimum, 8 GB recommended

Install

The fastest path on macOS or Linux:

curl -fsSL https://install.syndicatecode.ca/install.sh | bash

Windows (PowerShell):

irm https://install.syndicatecode.ca/install.ps1 | iex

See Installation for verified install, Homebrew, and source build options.

Initialize and run

syndicate init    # initialize .syndicate/ workspace state
syndicate         # launch TUI (onboarding wizard runs on first start)

The onboarding wizard walks through provider selection and API key configuration. After onboarding completes, the TUI shows the five-pane layout: title bar, left sidebar, main pane, right sidebar (governance), and footer input.

See First Run for bootstrap stages, headless mode, and audit chain verification.

In this section

  • Installation — install methods, verified install, platform support
  • First Run — bootstrap sequence, TUI layout, first governed workflow
  • Core Concepts — proposals, permits, checkpoints, trust, policy