Skip to content

Configuration API

Programmatic configuration reference for plugins, agents, and integrations.

File Locations

PlatformPath
Linux / macOS~/.config/synerix/config.toml
Windows%APPDATA%\synerix\config.toml

Full Configuration Schema

toml
[llm]
provider = "deepseek"          # deepseek, custom
model = "deepseek-v4-flash"
api_key = "sk-..."
base_url = "https://api.deepseek.com"

[ui]
theme = "dark"                 # dark, light
keymap = "default"             # default, vim, emacs
animation = true

[sandbox]
mode = "confirm"               # auto, confirm, strict

[coding]
mode = "plan"                  # plan, vibe

[agents.planner]
system_prompt = "You are a planning expert. Break down tasks into steps."
tools = ["search", "file_read"]
max_turns = 4

[agents.coder]
system_prompt = "You are an expert coder. Implement clean, tested code."
tools = ["file_read", "file_write", "shell_exec", "patch"]
max_turns = 8

[[workflows.pipelines.default]]
steps = ["planner", "coder"]

Runtime Config Access

rust
use synerix::config::Config;

let config = Config::load()?;
let model = config.llm.model;
let provider = config.llm.provider;

Environment Variables

VariableDescription
SYNERIX_API_KEYLLM API key
SYNERIX_BASE_URLCustom API base URL
SYNERIX_MODELOverride default model
SYNERIX_PROVIDEROverride default provider

Validation

Synerix validates configuration on load:

rust
use synerix::config::validation;

validation::validate(&config)?;

Invalid configs produce clear error messages pointing to the problematic field.

Next Steps

基于 VitePress 构建