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, join, status, doctor, sentinel, and profile.

Open PDF Download

📖

The Manual

Deep dive into state.db architecture, agent role config, budget enforcement, relay network, and the Sentinel daemon.

Open PDF Download

Install

curl -fsSL install.synlynk.com | bash

Getting Started

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

Daily Use

synlynk dispatch codex --task "..." --force-agent
synlynk jobs --watch
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

Upgrading?

If you installed synlynk before 2026-07, here's what's new: synlynk schedule (fleet batch dispatch), synlynk cost log (manual cost entries), a RATES line in synlynk status, and synlynk viz (local web HUD).

synlynk upgrade
synlynk doctor