Documentation

Everything you need to ship with synlynk.

⚡

Quick Start Guide

Get synlynk running in under 5 minutes. Covers install, init, first exec, and joining an existing workspace.

Open PDF Download
💻

Command Reference

Complete syntax for all synlynk commands: exec, dispatch, init, rollback, events tail, status, doctor, sentinel, and profile.

Open PDF Download
📖

The Manual

Deep dive into DB-canonical state.db architecture, write-through project docs, rollback checkpoints, event bus contracts, and Sentinel daemon.

Open PDF Download
🛰️

Watching Synlynk @Work

Observability guide for tracking dispatched agent work across the TUI, Vizor web dashboard, and Slack notifier.

Open PDF Download

Install

curl -fsSL install.synlynk.com | bash

Getting Started

synlynk init --dry-run
synlynk init --wizard
synlynk doctor
synlynk exec claude
synlynk status

Daily Use

synlynk dispatch codex --task "..." --force-agent
synlynk jobs --watch
synlynk events tail --limit 20
synlynk logs --job <id>
synlynk checkpoint

Team / PM

synlynk join
synlynk team status
synlynk story create ...
synlynk schedule --execute

Advanced / Operate

synlynk agent run <name>
synlynk scan --deep
synlynk viz --serve
synlynk rollback --last

Upgrading?

Upgrading to v0.13.1? Here's what's new: automatic mutation checkpointing and auto-restore on failure for synlynk init and synlynk upgrade, synlynk rollback [--last|<op-id>|--clear] for manual rollback, --dry-run preview flags, DB-canonical write-through project docs (State Engine PR1), GOVERNS event bus extensions (job_terminal, review_submitted) via synlynk events tail, and doctor TC-6 GitHub auth verification.

synlynk upgrade --dry-run
synlynk upgrade
synlynk rollback --last
synlynk doctor