Configuration¶
This section documents the on-disk file format. Before you use it, know which surface actually reads it where you run.
A server is configured in the browser, not in this file
A long running server keeps its configuration in its database and edits it in the dashboard's Configuration studio. From agentsmith.yml it reads the bootstrap slice at boot (persistence:, secrets: and the optional auth:) and ignores the rest. Catalog blocks written into a mounted ConfigMap have no effect there.
The CLI is the other case. It reads this whole file, exactly as documented below.
The two are bridged by agent-smith config import / export. Where configuration lives has the full model and a per-block table.
Configuration files¶
| File | Location | Purpose |
|---|---|---|
| agentsmith.yml | see below | agents, trackers, connections, repos, projects, secrets and the global settings |
| context.yaml, principles.md | .agentsmith/contexts/<name>/ in each repository |
what one component of a repo is and the rules it follows, see Context file |
| nuclei.yaml, spectral.yaml | config/ |
scanner settings for the api-scan pipeline, see Tool configuration |
Pages¶
- :material-file-cog: agentsmith.yml reference -- every block and key of the file
- :material-sitemap: agentsmith.yml schema -- the catalog model and how repo references resolve
- :material-routes: Project resolution -- how a ticket finds its project
- :material-account-group: Skills reference -- the SKILL.md format
- :material-tag-multiple: Concept vocabulary -- the concepts skills activate on
- :material-wrench: Tool configuration -- Nuclei and Spectral config for the api-scan pipeline
- :material-webhook: Webhooks -- endpoints, signature verification, PR comment commands
- :material-shield-check: Security scan config -- DAST (ZAP) and trend analysis configuration
File discovery¶
The CLI looks for agentsmith.yml in this order and takes the first one that exists:
--config <path>, when given.agentsmith/agentsmith.ymlin the current directoryconfig/agentsmith.ymlin the current directory.agentsmith/agentsmith.ymlin your home directory
A server reads its bootstrap slice from CONFIG_PATH, which the container images set to /app/config/agentsmith.yml.