Skip to main content
Methods:

​
Refresh Agent Instructions

  • Always writes the current Synth agent guidance into AGENTS.md, replacing the placeholder boilerplate.
  • Keeps Codex and any other agents aligned with the latest recommendations without altering app settings.
  • Run this regularly (or on CI) so your shared instructions stay fresh.

​
In your terminal, run:

uvx synth-ai codex

​
Launch Codex with Synth

  • Searches for a local codex install and offers to install it if missing.
  • Runs codex --version to confirm the binary is usable.
  • Applies CLI config overrides so Codex targets the Synth provider and default_model.
  • Emits OPENAI_API_KEY and SYNTH_API_KEY into the process environment before the app starts.
  • Still refreshes AGENTS.md first, so your agent-facing instructions are ready inside the workspace.

​
In your terminal, run:

uvx synth-ai codex --model synth-small

​
Example usage:

beck@Jacobs-Laptop my-training % uvx synth-ai codex --model synth-small

------------------------ CODEX CONFIG CHECK START -----------------------
Finding your installed Codex...
Found your installed Codex at /usr/local/bin/codex
Verifying your Codex is runnable via `codex --version`...
Verified your installed Codex is runnable
------------------------- CODEX CONFIG CHECK END ------------------------

Launching Codex command: codex -m synth-small -c model_providers.synth={name="Synth",base_url="https://api.usesynth.ai/synth-research",env_key="OPENAI_API_KEY"} -c model_provider="synth" -c default_model="synth-small"

​
Refresh Credentials

  • Pass --force to re-run the interactive credential resolver even if a key is cached. Pair with --model when you need to rotate keys.
  • Useful after rotating SYNTH_API_KEY or when switching accounts.

​
In your terminal, run:

uvx synth-ai codex --model synth-small --force