Getting started

InstallCopy Anchor Link

curl -fsSL https://getsynth.sh/install | sh

That installs the latest release to ~/.local/bin. Pass a version to pin one, or dev for the newest build of master:

curl -fsSL https://getsynth.sh/install | sh -s 0.2.0

SYNTH_INSTALL_DIR puts it somewhere else. Builds exist for macOS on Apple silicon and Linux on x86-64 or arm64; the script is short enough to read first.

On Debian or Ubuntu, from the apt repository:

curl -fsSL https://getsynth.sh/apt/synth.gpg | sudo tee /usr/share/keyrings/synth.gpg >/dev/null
echo "deb [signed-by=/usr/share/keyrings/synth.gpg] https://getsynth.sh/apt stable main" | sudo tee /etc/apt/sources.list.d/synth.list
sudo apt update && sudo apt install synth

With Homebrew instead:

brew tap aw1875/synth https://github.com/aw1875/synth.git
brew install aw1875/synth/synth

First runCopy Anchor Link

Start it in a project:

synth

With no provider connected it opens the provider picker. Pick one, give it a URL and an API key if it needs one, and the key is stored for next time. ctrl+p reopens that picker later, ctrl+o switches models across every connected provider.

The model has to support tool calls. To check one without opening the TUI:

synth run "list the files here"

NextCopy Anchor Link

• Using synth: keys, modes, approvals and rewind
• Configuration: every setting and where it lives
• CLI: subcommands, ACP for editors, and sessions over ssh