mirror of
https://github.com/fabro-sh/fabro.git
synced 2026-08-28 05:27:41 +00:00
bd195175fd
- Move Comparison link below Troubleshooting in nav - Rename "DOT Language" page to "Fabro Language" - Remove five-tier table from dark factory page, keep link to Dan Shapiro's post - Add fork command docs and checkpoints section - Add upgrade, asset list, asset cp command docs - Add upgrade_check config reference - Add retros feature flag to server config Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
283 lines
8.3 KiB
Text
283 lines
8.3 KiB
Text
---
|
|
title: "CLI Configuration"
|
|
description: "Configure default settings for the Fabro CLI with cli.toml"
|
|
---
|
|
|
|
Fabro loads CLI defaults from `~/.fabro/cli.toml` so you don't have to pass common flags every time. The file is optional — if it doesn't exist, built-in defaults are used.
|
|
|
|
## File location
|
|
|
|
The default path is `~/.fabro/cli.toml`. Fabro silently skips loading if the file is missing.
|
|
|
|
## Precedence
|
|
|
|
CLI flags always take the highest priority:
|
|
|
|
1. **CLI flags** — always win
|
|
2. **`cli.toml`** — used when no flag is provided
|
|
3. **Built-in defaults** — used when neither flag nor config is set
|
|
|
|
## Full example
|
|
|
|
```toml title="cli.toml"
|
|
verbose = true
|
|
upgrade_check = true
|
|
mode = "server"
|
|
|
|
[server]
|
|
base_url = "https://fabro.example.com:3000"
|
|
|
|
[server.tls]
|
|
cert = "~/.fabro/tls/client.crt"
|
|
key = "~/.fabro/tls/client.key"
|
|
ca = "~/.fabro/tls/ca.crt"
|
|
|
|
[exec]
|
|
provider = "anthropic"
|
|
model = "claude-opus-4-6"
|
|
permissions = "read-write"
|
|
output_format = "text"
|
|
|
|
[llm]
|
|
model = "claude-sonnet-4-5"
|
|
|
|
[log]
|
|
level = "info"
|
|
|
|
[git.author]
|
|
name = "fabro-bot"
|
|
email = "fabro-bot@company.com"
|
|
|
|
[pull_request]
|
|
enabled = true
|
|
|
|
[mcp_servers.filesystem]
|
|
type = "stdio"
|
|
command = ["npx", "-y", "@modelcontextprotocol/server-filesystem", "/workspace"]
|
|
startup_timeout_secs = 15
|
|
tool_timeout_secs = 90
|
|
|
|
[mcp_servers.filesystem.env]
|
|
NODE_ENV = "production"
|
|
|
|
[mcp_servers.sentry]
|
|
type = "http"
|
|
url = "https://mcp.sentry.dev/mcp"
|
|
|
|
[mcp_servers.sentry.headers]
|
|
Authorization = "Bearer sk-xxx"
|
|
```
|
|
|
|
All fields are optional. You can include just the sections and keys you want to override.
|
|
|
|
## `upgrade_check`
|
|
|
|
Controls whether Fabro runs a daily background check for new releases. The check runs during `run`, `exec`, `init`, and `install` commands and prints a notice to stderr when a newer version is available.
|
|
|
|
| Value | Description |
|
|
|---|---|
|
|
| `true` | Check for new releases (default) |
|
|
| `false` | Disable automatic upgrade checks |
|
|
|
|
The `--no-upgrade-check` CLI flag overrides this for a single invocation. See [`fabro upgrade`](/reference/cli#fabro-upgrade) for manual upgrades.
|
|
|
|
## `verbose`
|
|
|
|
Enable verbose output by default for `fabro run start` and `fabro doctor`, without passing `-v` every time.
|
|
|
|
| Value | Description |
|
|
|---|---|
|
|
| `true` | Verbose output on by default |
|
|
| `false` | Normal output (default) |
|
|
|
|
The `-v` / `--verbose` CLI flag always takes effect regardless of this setting.
|
|
|
|
## `[exec]` section
|
|
|
|
Defaults for `fabro exec` sessions.
|
|
|
|
| Key | Description | Values | Default |
|
|
|---|---|---|---|
|
|
| `provider` | LLM provider | `"anthropic"`, `"openai"`, `"gemini"`, etc. | `"anthropic"` |
|
|
| `model` | Model name | Any model ID from `fabro model list` | Per provider |
|
|
| `permissions` | Tool permission level | `"read-only"`, `"read-write"`, `"full"` | `"read-write"` |
|
|
| `output_format` | Output format | `"text"`, `"json"` | `"text"` |
|
|
|
|
### Permission levels
|
|
|
|
- **`read-only`** — auto-approves read tools (`read_file`, `grep`, `glob`, `list_dir`) and subagent tools
|
|
- **`read-write`** — adds write tools (`write_file`, `edit_file`, `apply_patch`)
|
|
- **`full`** — allows all tools including shell commands
|
|
|
|
Tools outside the permission level are interactively prompted (if a TTY is present) or denied (with `--auto-approve`).
|
|
|
|
### Output formats
|
|
|
|
- **`text`** — human-readable terminal output
|
|
- **`json`** — NDJSON event stream
|
|
|
|
## `[llm]` section
|
|
|
|
Defaults for `fabro llm prompt` and `fabro llm chat`.
|
|
|
|
| Key | Description | Values | Default |
|
|
|---|---|---|---|
|
|
| `model` | Model name | Any model ID from `fabro model list` | Per provider |
|
|
|
|
<Note>
|
|
The `[llm]` section only sets the default model. Use `[exec]` to configure provider, permissions, and output format for `fabro exec`.
|
|
</Note>
|
|
|
|
## `[log]` section
|
|
|
|
Configure the default log level. Precedence: `FABRO_LOG` env var > `--debug` flag > `[log]` level > `"info"`.
|
|
|
|
| Key | Description | Values | Default |
|
|
|---|---|---|---|
|
|
| `level` | Log level | `"error"`, `"warn"`, `"info"`, `"debug"`, `"trace"` | `"info"` |
|
|
|
|
## `[git]` section
|
|
|
|
### `[git.author]`
|
|
|
|
Customize the git author identity used for checkpoint commits. Overrides the server default when set.
|
|
|
|
| Key | Description | Default |
|
|
|---|---|---|
|
|
| `name` | Git author name | `"fabro"` |
|
|
| `email` | Git author email | `"fabro@local"` |
|
|
|
|
## `mode`
|
|
|
|
Controls whether commands run in-process or delegate to a running Fabro API server.
|
|
|
|
| Value | Description |
|
|
|---|---|
|
|
| `"standalone"` | Execute locally (default) |
|
|
| `"server"` | Delegate to an Fabro API server |
|
|
|
|
Override with the `--mode` CLI flag:
|
|
|
|
```bash
|
|
fabro --mode server models list
|
|
```
|
|
|
|
## `[server]` section
|
|
|
|
Configuration for server mode.
|
|
|
|
| Key | Description | Default |
|
|
|---|---|---|
|
|
| `base_url` | Server URL | `"http://localhost:3000"` |
|
|
|
|
Override the URL with the `--server-url` CLI flag:
|
|
|
|
```bash
|
|
fabro --mode server --server-url https://fabro.example.com:3000 models list
|
|
```
|
|
|
|
### `[server.tls]` section
|
|
|
|
Optional mTLS configuration for authenticating with the server. When present, the CLI presents a client certificate during the TLS handshake.
|
|
|
|
| Key | Description |
|
|
|---|---|
|
|
| `cert` | Path to client certificate PEM file |
|
|
| `key` | Path to client private key PEM file |
|
|
| `ca` | Path to CA certificate PEM file (to verify the server) |
|
|
|
|
Paths support `~/` expansion. Example:
|
|
|
|
```toml title="cli.toml"
|
|
[server.tls]
|
|
cert = "~/.fabro/tls/client.crt"
|
|
key = "~/.fabro/tls/client.key"
|
|
ca = "~/.fabro/tls/ca.crt"
|
|
```
|
|
|
|
## `[pull_request]`
|
|
|
|
Enable auto-PR globally so workflows open a GitHub pull request on successful completion — even when running with a `.fabro` file instead of a `run.toml`.
|
|
|
|
```toml title="cli.toml"
|
|
[pull_request]
|
|
enabled = true
|
|
```
|
|
|
|
| Key | Description | Default |
|
|
|---|---|---|
|
|
| `enabled` | Automatically create a PR after successful runs | `false` |
|
|
|
|
Precedence: `run.toml` > `fabro.toml` (project config) > `cli.toml` > `server.toml` > built-in default (`false`).
|
|
|
|
## `[mcp_servers]` section
|
|
|
|
Configure [MCP servers](/agents/mcp) to connect to during `fabro exec` sessions. Each server is a named TOML table under `[mcp_servers]`. MCP servers can also be configured per-workflow in [run config TOML](/execution/run-configuration#mcp_servers).
|
|
|
|
### Stdio transport
|
|
|
|
Spawn a local process and communicate over stdin/stdout:
|
|
|
|
```toml title="cli.toml"
|
|
[mcp_servers.filesystem]
|
|
type = "stdio"
|
|
command = ["npx", "-y", "@modelcontextprotocol/server-filesystem", "/workspace"]
|
|
startup_timeout_secs = 15
|
|
tool_timeout_secs = 90
|
|
|
|
[mcp_servers.filesystem.env]
|
|
NODE_ENV = "production"
|
|
```
|
|
|
|
| Key | Description | Default |
|
|
|---|---|---|
|
|
| `type` | Must be `"stdio"` | — |
|
|
| `command` | Array: executable + arguments | — |
|
|
| `env` | Additional environment variables for the child process | `{}` |
|
|
| `startup_timeout_secs` | Max seconds for the MCP handshake | `10` |
|
|
| `tool_timeout_secs` | Max seconds for a single tool call | `60` |
|
|
|
|
### HTTP transport
|
|
|
|
Connect to a remote MCP server over Streamable HTTP:
|
|
|
|
```toml title="cli.toml"
|
|
[mcp_servers.sentry]
|
|
type = "http"
|
|
url = "https://mcp.sentry.dev/mcp"
|
|
|
|
[mcp_servers.sentry.headers]
|
|
Authorization = "Bearer sk-xxx"
|
|
```
|
|
|
|
| Key | Description | Default |
|
|
|---|---|---|
|
|
| `type` | Must be `"http"` | — |
|
|
| `url` | The MCP server endpoint URL | — |
|
|
| `headers` | Optional HTTP headers (e.g., for authentication) | `{}` |
|
|
| `startup_timeout_secs` | Max seconds for the MCP handshake | `10` |
|
|
| `tool_timeout_secs` | Max seconds for a single tool call | `60` |
|
|
|
|
### Sandbox transport
|
|
|
|
Run an MCP server inside the workflow's sandbox and connect via preview URL. Only available with remote sandbox providers ([Daytona](/integrations/daytona)) that support port previews. Typically configured in [run config TOML](/execution/run-configuration#mcp_servers) rather than `cli.toml`.
|
|
|
|
```toml title="run.toml"
|
|
[mcp_servers.playwright]
|
|
type = "sandbox"
|
|
command = ["npx", "@playwright/mcp@latest", "--port", "3100", "--headless"]
|
|
port = 3100
|
|
startup_timeout_secs = 60
|
|
tool_timeout_secs = 120
|
|
```
|
|
|
|
| Key | Description | Default |
|
|
|---|---|---|
|
|
| `type` | Must be `"sandbox"` | — |
|
|
| `command` | Array: the command to run inside the sandbox | — |
|
|
| `port` | Port the server listens on inside the sandbox | — |
|
|
| `env` | Additional environment variables for the server process | `{}` |
|
|
| `startup_timeout_secs` | Max seconds for startup + MCP handshake | `10` |
|
|
| `tool_timeout_secs` | Max seconds for a single tool call | `60` |
|
|
|
|
See [MCP — Sandbox transport](/agents/mcp#sandbox) for how Fabro launches and connects to sandbox MCP servers.
|