Skip to main content
Methods:

​
Refresh Agent Instructions

  • Resolves the OpenCode binary (prompting for installation if missing) and verifies it can launch.
  • Writes the current Synth agent handbook into AGENTS.md, replacing the placeholder copy.
  • Handy for keeping automation up to date even when you do not want to modify OpenCode settings.

​
In your terminal, run:

uvx synth-ai opencode

​
Configure OpenCode with Synth

  • Provide --model to enable Synth inside OpenCode.
  • Prompts for SYNTH_API_KEY (respecting --force) and stores it in ~/.local/share/opencode/auth.json.
  • Loads ~/.config/opencode/opencode.json, creating it if needed, and inserts the Synth provider section with the selected model.
  • Sets model to synth/<model> so the desktop app opens pointed at Synth.

​
Example usage:

beck@Jacobs-Laptop my-training % uvx synth-ai opencode --model synth-medium

------------------------ OPENCODE CONFIG CHECK START ----------------------
Finding your installed OpenCode...
Found your installed OpenCode at /Applications/OpenCode.app/Contents/MacOS/opencode
Verifying your OpenCode is runnable via `opencode --version`...
Verified your installed OpenCode is runnable
Registering your Synth API key with OpenCode...
------------------------- OPENCODE CONFIG CHECK END -----------------------

Launching OpenCode...

​
Launch OpenCode

  • After refreshing AGENTS.md, starts the OpenCode binary in the same process.
  • Carries over any Synth configuration you applied with --model so the app opens ready to use.
  • Pass --force alongside --model to re-select credentials before launching.

​
In your terminal, run:

uvx synth-ai opencode --model synth-small