How to configure fak
Audience: operators configuring a first or existing fak deployment. Prerequisite: a working fak binary.
fak serve --help
Expected result: the command prints configuration flags and exits without starting a server.
These concise answers cover the decisions people most often make when configuring fak. For every fak serve flag, environment variable, and manifest field, use the complete server configuration reference.
How do I configure fak?
Start with fak config guide, which recommends no file for the default posture and explains minimal changes for other intents. fak serve also accepts explicit flags and an optional TOML manifest selected with –config; explicit flags override manifest values. Environment variables carry secrets and documented integration settings.
Where is the complete fak configuration reference?
The fak server configuration guide is the authoritative, human-readable reference for every fak serve flag and environment variable. The CLI help remains authoritative for other commands.
Does fak require a config file?
No. fak serve works with tested built-in defaults and command-line flags. A TOML deployment manifest is optional and is useful when reviewed deployment defaults should be reused.
What wins when a fak setting appears in more than one place?
Explicit command-line flags win over declared fak.toml values, and declared values win over built-in defaults. There is no implicit search for an ambient fak.toml, so changing directories cannot silently change a serve.
How can I inspect the effective fak serve configuration?
Run fak serve –print-effective-config, optionally with –config and any overriding flags. It prints JSON containing each effective value and whether it came from a flag, the manifest, or a default, then exits before starting the server.
How should secrets be configured in fak?
Keep secret values out of TOML manifests and command history. Put secrets in environment variables, configure fak with the variable name where required, and use –require-key-env when inbound API authentication must fail closed.
How do I validate a fak configuration before serving traffic?
Use fak serve –print-effective-config to parse the manifest, reject unsupported fields, apply explicit overrides, and show the resulting configuration without starting the server. Then use the documented health and readiness endpoints for deployment checks.
How do I configure which tools an agent may call?
Use a JSON capability-floor policy manifest. Start with fak policy –dump, edit the allow and deny rules, validate it with fak policy –check, reproduce expected verdicts with fak preflight –policy, and then load it with fak serve –policy or fak manage –policy.
How do I configure fak manage for a local coding agent?
Start with fak manage followed by the agent command. fak manage discovers the supported agent adapter, keeps generated state under the documented user configuration directory, and accepts explicit policy and runtime flags when the defaults need to be tightened.
How do I configure fak as an MCP server?
Add fak serve –stdio to the MCP server configuration used by Claude Code, Cursor, VS Code, or another MCP client. The MCP integration guide contains the complete .mcp.json example and a deterministic stdio verification command.
How do I configure a client or editor to use fak?
Use the integration guide for the client or editor you run. The integrations index links exact setup instructions for Claude Code, Codex, Cursor, VS Code, OpenAI-compatible clients, MCP, and managed runtimes.
How do I configure model providers and API credentials?
Choose the integration guide for the provider wire, point the client or fak serve at the documented base URL, and keep credentials in environment variables rather than manifests. The server configuration reference lists supported provider, model, endpoint, and credential-variable settings.
How do I configure one policy for an organization?
Use the centralized policy plane: sign an organization manifest, enroll each machine with the organization trust material, and verify the effective policy. Local operators may tighten the organization floor but cannot weaken it.
Complete configuration reference
Continue to fak Server Configuration Reference for the exhaustive option tables and deployment details.