CLI Commands Reference
This page covers the terminal commands you run from your shell.
For in-chat slash commands, see Slash Commands Reference. For registry-derived inventories of commands, providers, platforms, toolsets, and product routes, see the generated Runtime Surface Catalog.
Global entrypoint
fabric [global-options] <command> [subcommand/options]
Global options
| Option | Description |
|---|---|
--version, -V | Show version and exit. |
--profile <name>, -p <name> | Select which Fabric profile to use for this invocation. Overrides the sticky default set by fabric profile use. |
--resume <session>, -r <session> | Resume a previous session by ID or title. |
--continue [name], -c [name] | Resume the most recent session, or the most recent session matching a title. |
--worktree, -w | Start in an isolated git worktree for parallel-agent workflows. |
--yolo | Bypass dangerous-command approval prompts. |
--pass-session-id | Include the session ID in the agent's system prompt. |
--ignore-user-config | Ignore ~/.fabric/config.yaml and fall back to built-in defaults. Credentials in .env are still loaded. |
--ignore-rules | Skip project context (.fabric.md, FABRIC.md, AGENTS.md, CLAUDE.md, .cursorrules), SOUL.md, memory, and preloaded skills. |
--tui | Launch the TUI instead of the classic CLI. Always wins over display.interface. |
--cli | Force the classic prompt_toolkit REPL. Use this to override display.interface: tui for a single invocation. |
--dev | With --tui: run the TypeScript sources directly via tsx instead of the prebuilt bundle (for TUI contributors). |
Top-level commands
| Command | Purpose |
|---|---|
fabric chat | Interactive or one-shot chat with the agent. |
fabric model | Interactively choose the default provider and model. |
fabric moa | Configure named Mixture of Agents presets selectable from the model picker. |
fabric fallback | Manage fallback providers tried when the primary model errors. |
fabric gateway | Run or manage the messaging gateway service. |
fabric proxy | Local OpenAI-compatible proxy that attaches OAuth provider credentials. See Subscription Proxy. |
fabric lsp | Manage Language Server Protocol integration (semantic diagnostics for write_file/patch). |
fabric setup | Interactive setup wizard for all or one section (model, tts, terminal, gateway, tools, github, agent, or opt-in tailscale). |
fabric whatsapp | Configure and pair the WhatsApp bridge. |
fabric whatsapp-cloud | Configure the official Meta WhatsApp Business Cloud API adapter (Business account + public webhook required). Distinct from fabric whatsapp (Baileys personal-account bridge). |
fabric slack | Slack helpers (currently: generate the app manifest with every command as a native slash). |
fabric auth | Manage credentials — add, list, remove, reset, status, logout. Handles OAuth flows for Codex/Nous. |
fabric logout | Clear authentication for an inference provider. |
fabric send | Send a one-shot message to a configured messaging platform (Telegram, Discord, Slack, Signal, SMS, …). Useful from shell scripts, cron jobs, CI hooks, and monitoring daemons — no agent loop, no LLM. |
fabric secrets | Manage Bitwarden Secrets Manager and 1Password secret sources for resolving API keys at process startup. |
fabric migrate | Diagnose and (optionally) rewrite config.yaml to replace references to retired models or deprecated settings (e.g. migrate xai). |
fabric status | Show agent, auth, and platform status. |
fabric console | Open the curated Fabric command REPL. It is not a raw shell. |
fabric journey (aliases learning, memory-graph) | View and manage the learned-skill and memory timeline. |
fabric ollama | Pull and digest-verify an Ollama model in the foreground without changing the selected model. |
fabric cron | Inspect and tick the cron scheduler. |
fabric kanban | Multi-profile collaboration board (tasks, links, dispatcher). |
fabric project | Manage named, multi-folder workspaces (projects). Anchors desktop session grouping and, when bound to a kanban board, gives tasks a deterministic worktree + branch convention. State is per-profile. |
fabric loom | Deployment plane — register hosts (this machine or an SSH host), define projects, and deploy/roll back with a plan-before-mutation confirmation. State is per-profile. |
fabric webhook | Manage dynamic webhook subscriptions for event-driven activation. |
fabric hooks | Inspect, approve, or remove shell-script hooks declared in config.yaml. |
fabric doctor | Diagnose config and dependency issues. |
fabric security audit | On-demand supply-chain audit (OSV.dev) for the venv, plugin requirements, and pinned MCP servers. |
fabric dump | Copy-pasteable setup summary for support/debugging. |
fabric prompt-size | Show a byte breakdown of the system prompt + tool schemas (skills index, memory, profile). Runs offline. |
fabric debug | Debug tools — upload logs and system info for support. |
fabric backup | Back up Fabric home directory to a zip file. |
fabric checkpoints | Inspect / prune / clear ~/.fabric/checkpoints/ (the shadow store used by /rollback). Run with no args for a status overview. |
fabric disk | Report how much disk space Fabric is using (usage/du) and reclaim regenerable caches, rotated logs, traces, and scratch (clean, dry-run by default). |
fabric monitor | Live host metrics — CPU (aggregate + per-core), memory, disk, load, network throughput, and GPU (alias: fabric top). |
fabric import | Restore a Fabric backup from a zip file. |
fabric logs | View, tail, and filter agent/gateway/error log files. |
fabric config | Show, edit, migrate, and query configuration files. |
fabric pairing | Approve or revoke messaging pairing codes. |
fabric skills | Browse, install, publish, audit, and configure skills. |
fabric bundles | Group several skills under a single /<name> slash command. See Skill Bundles. |
fabric curator | Background skill maintenance — status, run, pause, pin. See Curator. |
fabric memory | Configure Fabric memory and inspect static readiness. Plugin-specific commands register for the configured adapter. |
fabric acp | Run Fabric as an ACP server for editor integration. |
fabric mcp | Manage MCP server configurations and run Fabric as an MCP server. |
fabric plugins | Manage Fabric plugins (install, enable, disable, remove). |
fabric portal | Nous Portal onboarding, status, subscription link, and Tool Gateway routing. First login requires --client-id <registered-client-id>. See Tool Gateway. |
fabric tools | Configure enabled tools per platform. |
fabric computer-use | Install or check the cua-driver backend (macOS Computer Use). |
fabric pets | Browse, install, and select petdex animated pets shown across the CLI, TUI, and desktop app. Subcommands: list, install, select, show, off, scale, remove, doctor. |
fabric sessions | Browse, export, prune, rename, and delete sessions. |
fabric insights | Show token/cost/activity analytics. |
fabric claw | OpenClaw migration helpers. |
fabric dashboard | Launch the web dashboard for managing config, API keys, and sessions. |
fabric serve | Run the dashboard/desktop JSON-RPC and WebSocket backend without serving the SPA. |
fabric desktop (alias gui) | Build and launch the native Electron desktop app. |
fabric profile | Manage profiles — multiple isolated Fabric instances. |
fabric completion | Print shell completion scripts (bash/zsh/fish). |
fabric version | Show version information. |
fabric update | Pull latest code and reinstall dependencies. --check previews without installing; --backup takes a pre-pull FABRIC_HOME snapshot. |
fabric uninstall | Remove Fabric from the system. |
fabric chat
fabric chat [options]
Common options:
| Option | Description |
|---|---|
-q, --query "..." | One-shot, non-interactive prompt. |
-m, --model <model> | Override the model for this run. |
-t, --toolsets <csv> | Enable a comma-separated set of toolsets. |
--provider <provider> | Force a configured provider (or auto). Run fabric chat --help for accepted choices; the generated Runtime Surface Catalog lists canonical provider IDs and aliases from source. |
-s, --skills <name> | Preload one or more skills for the session (can be repeated or comma-separated). |
-v, --verbose | Verbose output. |
-Q, --quiet | Programmatic mode: suppress banner/spinner/tool previews. |
--image <path> | Attach a local image to a single query. |
--resume <session> / --continue [name] | Resume a session directly from chat. |
--worktree | Create an isolated git worktree for this run. |
--checkpoints | Enable filesystem checkpoints before destructive file changes. |
--yolo | Skip approval prompts. |
--pass-session-id | Pass the session ID into the system prompt. |
--ignore-user-config | Ignore ~/.fabric/config.yaml and use built-in defaults. Credentials in .env are still loaded. Useful for isolated CI runs, reproducible bug reports, and third-party integrations. |
--ignore-rules | Skip auto-injection of AGENTS.md, SOUL.md, .cursorrules, persistent memory, and preloaded skills. Combine with --ignore-user-config for a fully isolated run. |
--safe-mode | Troubleshooting mode: disable ALL customizations — user config, rules/memory injection, plugins, shell hooks, and MCP servers (implies --ignore-user-config and --ignore-rules). Use to isolate whether a problem comes from your setup or from Fabric itself. |
--source <tag> | Session source tag for filtering (default: cli). Use tool for third-party integrations that should not appear in user session lists. |
--max-turns <N> | Maximum tool-calling iterations per conversation turn (default: 90, or agent.max_turns in config). |
Examples:
fabric
fabric chat -q "Summarize the latest PRs"
fabric chat --provider openrouter --model anthropic/claude-sonnet-4.6
fabric chat --toolsets web,terminal,skills
fabric chat --quiet -q "Return only JSON"
fabric chat --worktree -q "Review this repo and open a PR"
fabric chat --ignore-user-config --ignore-rules -q "Repro without my personal setup"
fabric chat --safe-mode -q "Is this bug mine or Fabric's?"
fabric -z <prompt> — scripted one-shot
For programmatic callers (shell scripts, CI, cron, parent processes piping in a prompt), fabric -z is the purest one-shot entry point: single prompt in, final response text out, nothing else on stdout or stderr. No banner, no spinner, no tool previews, no Session: line — just the agent's final reply as plain text.
fabric -z "What's the capital of France?"
# → Paris.
# Parent scripts can cleanly capture the response:
answer=$(fabric -z "summarize this" < /path/to/file.txt)
Per-run overrides (no mutation to ~/.fabric/config.yaml):
| Flag | Purpose |
|---|---|
-m / --model <model> | Override the model for this run |
--provider <provider> | Override the provider for this run |
fabric -z "…" --provider openrouter --model openai/gpt-5.5
Same agent, same tools, same skills — just strips every interactive / cosmetic layer. If you need tool output in the transcript too, use fabric chat -q instead; -z is explicitly for "I only want the final answer".
fabric model
Interactive provider + model selector. This is the command for adding new providers, setting up API keys, and running OAuth flows. Run it from your terminal — not from inside an active Fabric chat session.
fabric model
Use this when you want to:
- add a new provider (OpenRouter, Anthropic, Copilot, DeepSeek, custom, etc.)
- log into OAuth-backed providers (Copilot, Codex, Nous Portal)
- enter or update API keys
- pick from provider-specific model lists
- configure a custom/self-hosted endpoint
- save the new default into config
fabric model (run from your terminal, outside any Fabric session) is the full provider setup wizard. It can add new providers, run OAuth flows, prompt for API keys, and configure endpoints.
/model (typed inside an active Fabric chat session) can only switch between providers and models you've already set up. It cannot add new providers, run OAuth, or prompt for API keys.
If you need to add a new provider: Exit your Fabric session first (Ctrl+C or /quit), then run fabric model from your terminal prompt.
/model slash command (mid-session)
Switch between already-configured models without leaving a session:
/model # Show current model and available options
/model claude-sonnet-4 # Switch model (auto-detects provider)
/model zai:glm-5 # Switch provider and model
/model custom:qwen-2.5 # Use model on your custom endpoint
/model custom # Auto-detect model from custom endpoint
/model custom:local:qwen-2.5 # Use a named custom provider
/model openrouter:anthropic/claude-sonnet-4 # Switch back to cloud
By default, /model changes apply to the current session only. Add --global to persist the change to config.yaml:
/model claude-sonnet-4 --global # Switch and save as new default
If you've only configured OpenRouter, /model will only show OpenRouter models. To add another provider (Anthropic, DeepSeek, Copilot, etc.), exit your session and run fabric model from the terminal.
Provider and base URL changes are persisted to config.yaml automatically. When switching away from a custom endpoint, the stale base URL is cleared to prevent it leaking into other providers.
fabric gateway
fabric gateway <subcommand>
Subcommands:
| Subcommand | Description |
|---|---|
run | Run the gateway in the foreground. Recommended for WSL, Docker, and Termux. |
start | Start the installed systemd/launchd background service. |
stop | Stop the service (or foreground process). |
restart | Restart the service. |
status | Show service status. |
list | List all profiles and whether each profile's gateway is currently running (with PID where available). Handy when you run multiple profiles side-by-side and want a single overview. |
install | Install as a systemd (Linux) or launchd (macOS) background service. |
uninstall | Remove the installed service. |
setup | Interactive messaging-platform setup. |
enroll | Experimental: enroll this gateway with a relay connector and save relay credentials for connector-backed platforms. |
Options:
| Option | Description |
|---|---|
--all | On start / restart / stop: act on every profile's gateway, not just the active FABRIC_HOME. Useful if you run multiple profiles side-by-side and want to restart them all after fabric update. |
--no-supervise | On run: inside the s6-overlay Docker image, opt out of auto-supervision and use pre-s6 foreground semantics — gateway runs as the container's main process with no auto-restart. No-op outside the s6 image. |
fabric gateway enroll accepts --token, --connector-url, --gateway-id, and --wake-url. It exchanges the enrollment token with the connector and writes the resulting GATEWAY_RELAY_ID, GATEWAY_RELAY_SECRET, GATEWAY_RELAY_DELIVERY_KEY, optional GATEWAY_RELAY_URL, and (when --wake-url is given) GATEWAY_RELAY_WAKE_URL values to the active profile's .env.
Use fabric gateway run instead of fabric gateway start — WSL's systemd support is unreliable. Wrap it in tmux for persistence: tmux new -s fabric 'fabric gateway run'. See WSL FAQ for details.
fabric lsp
fabric lsp <subcommand>
Manage the Language Server Protocol integration. LSP runs real
language servers (pyright, gopls, rust-analyzer, …) in the
background and feeds their diagnostics into the post-write check
used by write_file and patch. Gated on git workspace detection
— LSP only runs when the cwd or edited file is inside a git
worktree.
Subcommands:
| Subcommand | Description |
|---|---|
status | Show service state, configured servers, install status. |
list | Print the registry of supported servers. Pass --installed-only to skip missing ones. |
install <id> | Eagerly install one server's binary. |
install-all | Install every server with a known auto-install recipe. |
restart | Tear down running clients so the next edit re-spawns. |
which <id> | Print the resolved binary path for one server. |
See LSP — Semantic Diagnostics for the full guide, supported languages, and configuration knobs.
fabric setup
fabric setup [model|tts|terminal|gateway|tools|github|tailscale|agent] [--non-interactive] [--reset] [--quick] [--reconfigure] [--portal]
Run fabric setup for the full interactive wizard, or use fabric model and
fabric tools to configure model and tool routes independently.
First run: launches the first-time wizard.
Returning user (already configured): drops straight into the full reconfigure wizard — every prompt shows your current value as its default, press Enter to keep or type a new value. No menu.
Jump into one section instead of the full wizard:
| Section | Description |
|---|---|
model | Provider and model setup. |
tts | Text-to-speech provider and voice setup. |
terminal | Terminal backend and sandbox setup. |
gateway | Messaging platform setup. |
tools | Enable/disable tools per platform. |
github | Connect a GitHub account: browser device-code sign-in (or a personal access token), saved as GITHUB_TOKEN for the GitHub skills. Offers to star the Fabric repo and points at the fabric-contribute skill for filing feature requests and bug reports. |
tailscale | Opt-in private Tailscale access setup. |
agent | Agent behavior settings. |
Options:
| Option | Description |
|---|---|
--quick | On returning-user runs: only prompt for items that are missing or unset. Skip items you already have configured. |
--non-interactive | Use defaults / environment values without prompts. |
--reset | Reset configuration to defaults before setup. |
--reconfigure | Backwards-compat alias — bare fabric setup on an existing install now does this by default. |
--portal | One-shot Nous Portal setup: log in via OAuth, set Nous as the inference provider, and opt into the Tool Gateway. Skips the rest of the wizard. First-time login also requires --client-id <registered-client-id>. |
--client-id <id> | Registered Nous OAuth client ID used by --portal; required for first-time login. |
fabric loom
Loom is Fabric's built-in deployment plane: it takes a source (a Docker Compose project or the built-in "host Fabric itself" template) and runs it on a destination you choose — this machine, or a Linux host over SSH — with a plan you confirm before anything changes, health-gated activation, and rollback.
fabric loom setup # register "this-machine" and print next steps
fabric loom status # hosts / projects / active deployments
fabric loom host add <name> --kind ssh --address <ip> --user <user> --key <path>
fabric loom host scan <name> # read-only adoption scan (OS/arch/docker)
fabric loom host list
fabric loom project add <name> --kind compose --source <dir> --compose-file docker-compose.yml
fabric loom project list
fabric loom deploy <project> <host> # shows the plan, asks to confirm, then deploys
fabric loom rollback <project> <host> # reactivate the previous release
fabric loom logs <deployment-id>
deploy prints the plan and prompts before mutating; pass --yes to skip the
prompt (for scripts) and --allow-destructive to approve destructive steps. A
candidate that fails to build, start, or pass its health check never displaces
the currently healthy release. The same operations are available in the
dashboard's Deploy page and, for
agents, through the opt-in loom toolset.
fabric portal
fabric portal --client-id <registered-client-id>
fabric portal login --client-id <registered-client-id>
fabric portal [info|status|open|tools]
Run the one-shot Nous login, model selection, and Tool Gateway setup. A first-time login requires an explicitly supplied registered Nous OAuth client ID. Use the subcommands below to inspect an existing login or open the Portal.
| Subcommand | Description |
|---|---|
login (default) | Run the one-shot onboarding flow. Requires --client-id <registered-client-id> for first-time login. |
info / status | Portal auth state + per-tool Tool Gateway routing summary. |
open | Open portal.nousresearch.com/manage-subscription in your default browser. |
tools | List every Tool Gateway partner (Firecrawl, FAL, OpenAI TTS, Browser Use, Modal) and which are routed via Nous. |
For configuration of the gateway itself, see Tool Gateway. For the one-shot setup path, see fabric setup --portal above.
fabric whatsapp
fabric whatsapp
Runs the WhatsApp pairing/setup flow, including mode selection and QR-code pairing.
fabric slack
fabric slack manifest # print manifest to stdout
fabric slack manifest --write # write to ~/.fabric/slack-manifest.json
fabric slack manifest --slashes-only # just the features.slash_commands array
Generates a Slack app manifest that registers every gateway command in
COMMAND_REGISTRY (/btw, /stop, /model, …) as a first-class
Slack slash command — matching Discord and Telegram parity. Paste the
output into your Slack app config at
https://api.slack.com/apps → your app →
Features → App Manifest → Edit, then Save. Slack prompts for
reinstall if scopes or slash commands changed.
| Flag | Default | Purpose |
|---|---|---|
--write [PATH] | stdout | Write to a file instead of stdout. Bare --write writes $FABRIC_HOME/slack-manifest.json. |
--name NAME | Fabric | Bot display name in Slack. |
--description DESC | default blurb | Bot description shown in the Slack app directory. |
--slashes-only | off | Emit only features.slash_commands for merging into a manually-maintained manifest. |
Run fabric slack manifest --write again after fabric update to pick
up any new commands.
fabric send
fabric send --to <target> "message text"
fabric send --to <target> --file <path>
echo "message" | fabric send --to <target>
fabric send --list [platform]
Send a one-shot message to a configured messaging platform without spinning up an agent or gateway loop. Reuses the gateway's already-configured credentials (~/.fabric/.env + ~/.fabric/config.yaml) so ops scripts, cron jobs, CI hooks, and monitoring daemons can post status updates without reimplementing each platform's REST client.
For bot-token platforms (Telegram, Discord, Slack, Signal, SMS, WhatsApp-CloudAPI) no running gateway is required — fabric send talks directly to the platform's REST endpoint. Plugin platforms that need a persistent adapter still require a live gateway.
| Option | Description |
|---|---|
-t, --to <TARGET> | Delivery target. Formats: platform (uses home channel), platform:chat_id, platform:chat_id:thread_id, or platform:#channel-name. Examples: telegram, telegram:-1001234567890, discord:#ops, slack:C0123ABCD, signal:+15551234567. |
-f, --file <PATH> | Read the message body from PATH (text files only — logs, reports, markdown). Pass - to force reading from stdin. To send an image or other binary file, use MEDIA:<path> (see below). |
-s, --subject <LINE> | Prepend a subject/header line before the message body. |
-l, --list [platform] | List configured targets across all platforms (or only the given platform). |
-q, --quiet | Suppress stdout on success — useful in scripts (rely on exit code only). |
--json | Emit raw JSON result instead of human-readable output. |
If neither a positional message argument nor --file is provided, fabric send reads from stdin when it is not a TTY. Exit codes: 0 on success, 1 on delivery/backend failure, 2 on usage errors.
Sending images and other media
--file is for text bodies only. To deliver an image, document, video, or audio file as a native platform attachment, reference it inside the message text with the MEDIA:<local_path> directive:
fabric send --to telegram "MEDIA:/tmp/screenshot.png"
fabric send --to telegram "Build chart for today MEDIA:/tmp/chart.png" # with caption
fabric send --to discord:#ops "MEDIA:/tmp/report.pdf"
By default, image files are sent as photos (platforms like Telegram recompress these). Add [[as_document]] to the message to deliver them as uncompressed file attachments instead:
fabric send --to telegram "[[as_document]] MEDIA:/tmp/screenshot.png"
Examples:
fabric send --to telegram "deploy finished"
echo "RAM 92%" | fabric send --to telegram:-1001234567890
fabric send --to discord:#ops --file /tmp/report.md
fabric send --to slack:#eng --subject "[CI]" --file build.log
fabric send --list # all platforms
fabric send --list telegram # filter by platform
fabric secrets
fabric secrets bitwarden <subcommand>
fabric secrets bw <subcommand> # short alias
fabric secrets onepassword <subcommand>
fabric secrets op <subcommand> # aliases: op, 1password
Resolve API keys from an external secret manager at process startup. Fabric supports Bitwarden Secrets Manager and 1Password. See the Secrets overview, Bitwarden integration, and 1Password integration.
bitwarden (alias bw) subcommands:
| Subcommand | Description |
|---|---|
setup | Interactive wizard: install the pinned bws binary, store an access token, and pick a project. Accepts --project-id, --access-token, and --server-url for non-interactive use. |
status | Show current config, binary path/version, and last fetch info. |
sync | Fetch secrets now and report what changed. Add --apply to exercise the startup apply path in the current Fabric process (default is dry-run); it cannot mutate its parent shell. |
install | Download and verify the pinned bws binary. --force re-downloads even if a managed copy already exists. |
disable | Turn off the Bitwarden integration. |
onepassword (aliases op, 1password) subcommands:
| Subcommand | Description |
|---|---|
setup | Verify the installed op CLI, select an account or service-account token variable, and enable the source. Fabric does not install op. |
status | Show 1Password configuration, CLI/auth status, and reference mappings. |
set <ENV_VAR> <op://reference> | Map an environment variable to a 1Password item reference. |
remove <ENV_VAR> | Remove one reference mapping. |
sync | Resolve configured references now. Add --apply to exercise the startup apply path in the current Fabric process (default is dry-run); it cannot mutate its parent shell. |
disable | Turn off the 1Password integration. |
fabric migrate
fabric migrate <type>
Diagnose and (optionally) rewrite the active config.yaml to replace references to retired models or deprecated settings. A timestamped backup of the original config.yaml is taken before any rewrite (skip with --no-backup).
| Subcommand | Description |
|---|---|
xai | Scan config.yaml for references to xAI models retired on May 15, 2026 and (with --apply) rewrite them in-place to the official replacements per the xAI migration guide. Defaults to dry-run. |
Common flags for migration subcommands:
| Flag | Description |
|---|---|
--apply | Rewrite config.yaml in-place (default: dry-run, no writes). |
--no-backup | Skip the timestamped backup of config.yaml when applying. |
Not to be confused with
fabric claw migrate(one-shot import of OpenClaw configuration into Fabric) —fabric migrateis the top-level config-rewrite command.
fabric proxy
fabric proxy <subcommand>
Run a local OpenAI-compatible HTTP server that forwards requests to an OAuth-authenticated upstream provider (e.g. Nous Portal, xAI). External apps can point at the proxy with any bearer token; the proxy attaches your real OAuth credentials on the way out. See Subscription Proxy for the full guide.
| Subcommand | Description |
|---|---|
start | Run the proxy in the foreground. Flags: --provider <nous|xai> (default nous), --host <addr> (default 127.0.0.1; use 0.0.0.0 to expose on LAN), --port <int> (default 8645). |
status | Show which proxy upstreams are ready (credentials present, OAuth valid). |
providers | List available proxy upstream providers. |
fabric security
fabric security <subcommand>
On-demand vulnerability scan against OSV.dev. Covers the Fabric venv (installed PyPI distributions), Python dependencies declared by plugins under ~/.fabric/plugins/, and pinned npx/uvx MCP servers in config.yaml. Does NOT scan globally-installed packages or editor/browser extensions.
| Subcommand | Description |
|---|---|
audit | Run a one-shot supply-chain audit. |
audit flags:
| Flag | Default | Description |
|---|---|---|
--json | off | Emit machine-readable JSON instead of human-readable text. |
--fail-on <level> | critical | Exit non-zero when any finding meets this severity (low, moderate, high, critical). |
--skip-venv | off | Skip scanning the Fabric Python venv. |
--skip-plugins | off | Skip scanning plugin requirements files. |
--skip-mcp | off | Skip scanning pinned MCP servers in config.yaml. |
fabric logout
Clear authentication for the active inference provider, or select one with
--provider. Credential pools can also be managed through fabric auth.
fabric auth
Manage credential pools for same-provider key rotation. See Credential Pools for full documentation.
fabric auth # Interactive wizard
fabric auth list # Show all pools
fabric auth list openrouter # Show specific provider
fabric auth add openrouter --api-key sk-or-v1-xxx # Add API key
fabric auth add anthropic --api-key sk-ant-xxx # Add Anthropic API key
fabric auth add nous --client-id <registered-client-id> # Add Nous device-code OAuth
fabric auth remove openrouter 2 # Remove by index
fabric auth reset openrouter # Clear cooldowns
fabric auth status anthropic # Show auth status for a provider
fabric auth logout anthropic # Log out and clear stored auth state
fabric auth spotify # Authenticate Fabric with Spotify via PKCE
Subcommands: add, list, remove, reset, status, logout, spotify. When called with no subcommand, launches the interactive management wizard.
Nous Portal does not have a built-in Fabric OAuth client ID. A first-time
login therefore requires an explicitly supplied, registered Nous OAuth client
ID. Refresh, scope step-up, shared-profile import, and dashboard sign-in reuse
the client ID stored by that successful login; if it is missing, run the
command above again with --client-id.
fabric status
fabric status [--all] [--deep]
| Option | Description |
|---|---|
--all | Show all details in a shareable redacted format. |
--deep | Run deeper checks that may take longer. |
fabric console
fabric console
Open a curated Fabric-command REPL. Enter supported commands without the
leading fabric (for example, status, sessions list, or cron status).
The console rejects shell syntax and arbitrary executables, asks for explicit
confirmation before mutating commands, and provides help, history, clear,
exit, and quit built-ins. Run help inside the console for the live command
set.
fabric journey
fabric journey [--play] [--json]
fabric journey list
fabric journey edit <node-id>
fabric journey delete <node-id> [--yes]
Render the same learned-skill and memory timeline used by the TUI Journey
overlay and desktop Memory Graph. Aliases: fabric learning and
fabric memory-graph. list prints stable node IDs; edit opens the selected
skill or memory in $EDITOR; delete archives a learned skill or removes a
memory after confirmation.
fabric ollama
fabric [-p PROFILE] ollama pull [MODEL] [--host URL] [--yes]
pull runs in the foreground, confirms the network/disk mutation, streams
bounded progress, and verifies the final installed model digest through a fresh
Ollama catalog read. If MODEL is omitted, the selected profile must already
contain a local Ollama/custom model. An explicit model with no configured local
route defaults to http://127.0.0.1:11434.
| Option | Description |
|---|---|
MODEL | Exact Ollama model ID/tag. Does not change Fabric's selected model. |
--host URL | Explicit Ollama daemon. The first release accepts localhost or a literal loopback/private IP and rejects DNS hostnames to prevent rebinding. |
--yes | Skip the prompt after explicit approval; required in a non-interactive shell. |
Exit codes are 0 for final digest verification, 1 for validation/pull
failure, and 130 when Fabric's client request is cancelled. Ctrl+C does not
claim daemon acknowledgement or delete partial layers. The command persists
only a sanitized profile ledger; it does not edit model/fallback/session state.
See Use a Local Ollama Model with Fabric for
setup and verification.
fabric cron
fabric cron <list|create|edit|pause|resume|run|remove|status|tick>
| Subcommand | Description |
|---|---|
list | Show scheduled jobs. |
create / add | Create a scheduled job from a prompt, optionally attaching one or more skills via repeated --skill. |
edit | Update a job's schedule, prompt, name, delivery, repeat count, or attached skills. Supports --clear-skills, --add-skill, and --remove-skill. |
pause | Pause a job without deleting it. |
resume | Resume a paused job and compute its next future run. |
run | Trigger a job on the next scheduler tick. |
remove | Delete a scheduled job. |
status | Check whether the cron scheduler is running. |
tick | Run due jobs once and exit. |
The cron trigger is pluggable via the cron.provider config key. Empty
(the default) uses the built-in in-process ticker. To use an external scheduler,
install a scheduler-provider plugin and set cron.provider to its registered
name. Unknown or unavailable providers fall back to the built-in, so cron is
never left without a trigger. See the
cron internals doc.
fabric kanban
fabric kanban [--board <slug>] <action> [options]
Multi-profile, multi-project collaboration board. Each install can host many boards (one per project, repo, or domain); each board is a standalone queue with its own SQLite DB and dispatcher scope. New installs start with one board called default, whose DB is ~/.fabric/kanban.db for back-compat; additional boards live at ~/.fabric/kanban/boards/<slug>/kanban.db. The gateway-embedded dispatcher sweeps every board per tick.
Global flags (apply to every action below):
| Flag | Purpose |
|---|---|
--board <slug> | Operate on a specific board. Defaults to the board selected by fabric kanban boards switch, or default. |
This is the human / scripting surface. Agent workers spawned by the dispatcher drive the board through a dedicated kanban_* toolset (kanban_show, kanban_complete, kanban_block, kanban_create, kanban_link, kanban_comment, kanban_heartbeat; orchestrator profiles also get kanban_list and kanban_unblock) instead of shelling to fabric kanban. Workers receive a private board scope from the dispatcher so they physically cannot see other boards.
| Action | Purpose |
|---|---|
init | Create kanban.db if missing. Idempotent. |
boards list / boards ls | List all boards with task counts. --json, --all (include archived). |
boards create <slug> | Create a new board. Flags: --name, --description, --icon, --color, --switch (make active). Slug is kebab-case, auto-downcased. |
boards switch <slug> / boards use | Persist <slug> as the active board (writes ~/.fabric/kanban/current). |
boards show / boards current | Print the currently-active board's name, DB path, and task counts. |
boards rename <slug> "<name>" | Change a board's display name. Slug is immutable. |
boards set-default-workdir <slug> [path] | Set or clear the default task workspace for a board. |
boards rm <slug> | Archive (default) or hard-delete a board. --delete skips the archive step. Archived boards move to boards/_archived/<slug>-<ts>/. Refused for default. |
create "<title>" | Create a task. Supports dependencies, explicit/project workspaces, branch, assignee, skills, triage, idempotency, runtime/retry limits, goal-loop mode, and initial status. Run fabric kanban create --help for the complete flags. |
swarm "<goal>" | Create the built-in parallel-workers → verifier → synthesizer task graph. |
list / ls | List and filter tasks by assignee, status, tenant, session, workflow/step, archive state, or sort order. --json emits machine-readable rows. |
show <id> | Show a task with comments and events. --json for machine output. |
assign <id> <profile> | Assign or reassign. Use none to unassign. Refused while task is running. |
reclaim <id> | Release an active worker claim so a stuck running task can recover. |
reassign <id> <profile> | Change the assignee, optionally reclaiming an active worker first. |
diagnostics / diag | Show board health findings, optionally filtered by severity or task. |
link <parent> <child> | Add a dependency. Cycle-detected. Both tasks must be on the same board. |
unlink <parent> <child> | Remove a dependency. |
claim <id> | Atomically claim a ready task. Prints resolved workspace path. |
comment <id> "<text>" | Append a comment. The next worker that claims the task reads it as part of its kanban_show() response. |
complete <id> [id ...] | Mark one or more tasks done. Flags: --result, --summary, --metadata. |
edit <id> --result ... | Backfill result/summary/metadata on an already-completed task. |
block <id> "<reason>" | Block one or more tasks with an optional typed reason (dependency, needs_input, capability, or transient). |
schedule <id> "<reason>" | Park time-delay/follow-up work in scheduled so it is not shown as a human blocker. |
unblock <id> [id ...] | Return blocked or scheduled tasks to ready (or todo if dependencies remain open). |
promote <id> | Manually move todo/blocked work to ready with audit reason, dry-run, and force controls. |
archive <id> [id ...] | Hide tasks from default lists; --rm permanently deletes tasks that are already archived. |
tail <id> | Follow a task's event stream. |
dispatch | One dispatcher pass on the active board. Flags: --dry-run, --max N, --failure-limit N, --json. |
daemon | Deprecated standalone dispatcher. Use the gateway-embedded dispatcher. |
watch | Stream board events, optionally filtered by assignee, tenant, or event kinds. |
stats | Show per-status/per-assignee counts and oldest-ready age. |
log <id> | Print a worker log, optionally limited to its last N bytes. |
runs <id> | Show per-attempt profile, outcome, elapsed time, and handoff summary. |
heartbeat <id> | Emit a worker liveness event with an optional note. |
assignees | List known profiles and per-profile task counts. |
notify-subscribe, notify-list, notify-unsubscribe | Manage gateway delivery subscriptions for terminal task events. |
context <id> | Print the full context a worker would see (title + body + parent results + comments). |
specify <id> / specify --all | Flesh out a triage-column task into a concrete spec (title + body with goal, approach, acceptance criteria) via the auxiliary LLM, then promote it to todo. Flags: --tenant (scope --all to one tenant), --author, --json. Configure the model under auxiliary.triage_specifier in config.yaml. |
decompose <id> / decompose --all | Fan a triage-column task out into a graph of child tasks routed to specialist profiles by description. Falls back to specify-style single-task promotion when the LLM decides the task doesn't benefit from fan-out. Same flags as specify. Configure the decomposer model under auxiliary.kanban_decomposer in config.yaml; kanban.orchestrator_profile only controls who owns the root/orchestration task after fan-out. Also runs automatically every dispatcher tick when kanban.auto_decompose: true (the default). See Auto vs Manual orchestration. |
gc | Remove scratch workspaces for archived tasks. |
Examples:
# Create a second board and put a task on it without switching away.
fabric kanban boards create atm10-server --name "ATM10 Server" --icon 🎮
fabric kanban --board atm10-server create "Restart server" --assignee ops
# Switch the active board for subsequent calls.
fabric kanban boards switch atm10-server
fabric kanban list # shows atm10-server tasks
# Archive a board (recoverable) or hard-delete it.
fabric kanban boards rm atm10-server
fabric kanban boards rm atm10-server --delete
Board resolution order for user commands (highest precedence first): --board <slug> flag → ~/.fabric/kanban/current file → default. Dispatcher-spawned workers receive their board scope internally.
All actions are also available as a slash command in the gateway (/kanban …), with the same argument surface — including boards subcommands and the --board flag.
For the product model, dashboard views, task lifecycle, and worker behavior, see the Kanban user guide.
fabric project
fabric project <create|list|show|add-folder|remove-folder|rename|set-primary|use|archive|restore|bind-board>
Projects are human-named workspaces that can span multiple folders / repos. They anchor desktop session grouping and, when bound to a kanban board, give tasks a deterministic worktree + branch convention. State is per-profile.
| Subcommand | Description |
|---|---|
create | Create a new project. |
list (alias ls) | List projects. |
show | Show a project's details. |
add-folder | Add a folder / repo to a project. |
remove-folder | Remove a folder from a project. |
rename | Rename a project. |
set-primary | Set the primary folder. |
use | Set the active project. |
archive | Archive a project (recoverable). |
restore | Restore an archived project. |
bind-board | Bind a kanban board to this project. |
fabric webhook
fabric webhook <subscribe|list|remove|test>
Manage dynamic webhook subscriptions for event-driven agent activation. Requires the webhook platform to be enabled in config — if not configured, prints setup instructions.
| Subcommand | Description |
|---|---|
subscribe / add | Create a webhook route. Returns the URL and HMAC secret to configure on your service. |
list / ls | Show all agent-created subscriptions. |
remove / rm | Delete a dynamic subscription. Static routes from config.yaml are not affected. |
test | Send a test POST to verify a subscription is working. |
fabric webhook subscribe
fabric webhook subscribe <name> [options]
| Option | Description |
|---|---|
--prompt | Prompt template with {dot.notation} payload references. |
--events | Comma-separated event types to accept (e.g. issues,pull_request). Empty = all. |
--description | Human-readable description. |
--skills | Comma-separated skill names to load for the agent run. |
--deliver | Delivery target: log (default), telegram, discord, slack, github_comment. |
--deliver-chat-id | Target chat/channel ID for cross-platform delivery. |
--secret | Custom HMAC secret. Auto-generated if omitted. |
--deliver-only | Skip the agent — deliver the rendered --prompt as the literal message. Zero LLM cost, sub-second delivery. Requires --deliver to be a real target (not log). |
--script | Filter/transform script under ~/.fabric/scripts/. The webhook payload is passed as JSON on stdin; JSON stdout replaces the payload, and empty stdout, [SILENT], or a nonzero exit code ignores the webhook. See Script Filters and Transforms. |
Subscriptions persist to ~/.fabric/webhook_subscriptions.json and are hot-reloaded by the webhook adapter without a gateway restart.
fabric doctor
fabric doctor [--fix]
| Option | Description |
|---|---|
--fix | Attempt automatic repairs where possible. |
fabric dump
fabric dump [--show-keys]
Outputs a compact, plain-text summary of your entire Fabric setup. Designed to be copy-pasted into Discord, GitHub issues, or Telegram when asking for support — no ANSI colors, no special formatting, just data.
| Option | Description |
|---|---|
--show-keys | Show redacted API key prefixes (first and last 4 characters) instead of just set/not set. |
What it includes
| Section | Details |
|---|---|
| Header | Fabric version, release date, git commit hash |
| Environment | OS, Python version, OpenAI SDK version |
| Identity | Active profile name, FABRIC_HOME path |
| Model | Configured default model and provider |
| Terminal | Backend type (local, docker, ssh, etc.) |
| API keys | Presence checks for the provider/tool keys known to the current build |
| Features | Enabled toolsets, MCP server count, memory provider |
| Services | Gateway status, configured messaging platforms |
| Workload | Cron job counts, installed skill count |
| Config overrides | Any config values that differ from defaults |
Example output
--- fabric dump ---
version: 0.8.0 (2026.4.8) [af4abd2f]
os: Linux 6.14.0-37-generic x86_64
python: 3.11.14
openai_sdk: 2.24.0
profile: default
fabric_home: ~/.fabric
model: anthropic/claude-opus-4.6
provider: openrouter
terminal: local
api_keys:
openrouter set
openai not set
anthropic set
nous not set
firecrawl set
...
features:
toolsets: all
mcp_servers: 0
memory_provider: built-in
gateway: running (systemd)
platforms: telegram, discord
cron_jobs: 3 active / 5 total
skills: 42
config_overrides:
agent.max_turns: 250
compression.threshold: 0.85
display.streaming: True
--- end dump ---
When to use
- Reporting a bug on GitHub — paste the dump into your issue
- Asking for help in Discord — share it in a code block
- Comparing your setup to someone else's
- Quick sanity check when something isn't working
fabric dump is specifically designed for sharing. For interactive diagnostics, use fabric doctor. For a visual overview, use fabric status.
fabric debug
fabric debug share [options]
Upload a debug report (system info + recent logs) to a paste service and get a shareable URL. Useful for quick support requests — includes everything a helper needs to diagnose your issue.
| Option | Description |
|---|---|
--lines <N> | Number of log lines to include per log file (default: 200). |
--expire <days> | Paste expiry in days (default: 7). |
--local | Print the report locally instead of uploading. |
--no-redact | Disable upload-time secret redaction. By default, uploads are redacted. |
The report includes system info (OS, Python version, Fabric version), recent agent, gateway, GUI/dashboard, and desktop logs (512 KB limit per file), and redacted API key status. By default, uploads are redacted so secrets are not included.
Uploads use public paste services tried in order: paste.rs, then dpaste.com.
Use --local when the report should not leave the machine.
Examples
fabric debug share # Upload debug report, print URL
fabric debug share --lines 500 # Include more log lines
fabric debug share --expire 30 # Keep paste for 30 days
fabric debug share --local # Print report to terminal (no upload)
fabric backup
fabric backup [options]
Create a zip archive of Fabric's profile-scoped configuration, credentials, built-in memory files, skills, sessions, and covered local data. The backup excludes the Fabric codebase itself.
The archive does not guarantee export of external/cloud memory records, replicas, or provider backups. Some adapters contribute local config or state paths, but no bundled external provider currently has a complete portable export/import contract. Use the provider's own export process where available.
| Option | Description |
|---|---|
-o, --output <path> | Output path for the zip file (default: ~/fabric-backup-<timestamp>.zip). |
-q, --quick | Quick snapshot: only critical state files (config.yaml, state.db, .env, auth, cron jobs). Much faster than a full backup. |
-l, --label <name> | Label for the snapshot (only used with --quick). |
The backup uses SQLite's backup() API for safe copying, so it works correctly even when Fabric is running (WAL-mode safe).
What's excluded from the zip:
*.db-wal,*.db-shm,*.db-journal— SQLite's WAL / shared-memory / journal sidecars. The*.dbfile already got a consistent snapshot viasqlite3.backup(); shipping the live sidecars alongside it would let a restore see a half-committed state.checkpoints/— per-session trajectory caches. Hash-keyed and regenerated per session; wouldn't port cleanly to another install anyway.- The Fabric code itself (this is a user-data backup, not a repo snapshot).
- External provider/service records that are not stored in a declared covered local path.
Examples
fabric backup # Full backup to ~/fabric-backup-*.zip
fabric backup -o /tmp/fabric.zip # Full backup to specific path
fabric backup --quick # Quick state-only snapshot
fabric backup --quick --label "pre-upgrade" # Quick snapshot with label
fabric checkpoints
fabric checkpoints [COMMAND]
Inspect and manage the shadow git store at ~/.fabric/checkpoints/ — the storage layer behind the in-session /rollback command. Safe to run any time; does not require the agent to be running.
| Subcommand | Description |
|---|---|
status (default) | Show total size, project count, and per-project breakdown. Bare fabric checkpoints is equivalent. |
list | Alias for status. |
prune | Force a cleanup sweep — delete orphan and stale projects, GC the store, enforce the size cap. Ignores the 24h idempotency marker. |
clear | Delete the entire checkpoint base. Irreversible; asks for confirmation unless -f. |
Options
| Option | Subcommand | Description |
|---|---|---|
--limit N | status, list | Max projects to list (default 20). |
--retention-days N | prune | Drop projects whose last_touch is older than N days (default 7). |
--max-size-mb N | prune | After the orphan/stale pass, drop the oldest commit per project until total store size ≤ N MB (default 500). |
--keep-orphans | prune | Skip deleting projects whose working directory no longer exists. |
-f, --force | clear | Skip the confirmation prompt. |
Examples
fabric checkpoints # status overview
fabric checkpoints prune --retention-days 3 # aggressive cleanup
fabric checkpoints prune --max-size-mb 200 # tighten size cap once
fabric checkpoints clear -f # wipe everything
See Checkpoints and /rollback for the full architecture and the in-session commands.
fabric disk
fabric disk <usage|clean> [options]
See where your Fabric home directory (~/.fabric, %LOCALAPPDATA%\fabric on Windows) is spending disk, and reclaim the parts that regenerate on their own. Safe to run any time; does not require the agent to be running.
| Subcommand | Description |
|---|---|
usage (alias du) | Break down disk used per store (caches, sessions, memory, databases, backups, …), largest-first, with a grand total and the free space left on the volume. |
clean | Reclaim regenerable data. Dry-run by default — prints what it would remove and deletes nothing until you pass --yes. |
fabric disk usage
| Option | Description |
|---|---|
--json | Machine-readable JSON report (categories, total_bytes, volume_free_bytes). |
-a, --all | Include categories that are currently empty. |
--profile NAME | Report usage for another profile instead of the active home. |
fabric disk clean
Only ever removes an explicit allow-list of regenerable data — caches, rotated
log backups (logs/*.log.*, never the live logs), diagnostic traces
(moa-traces/, spawn-trees/), temp scratch, and re-downloadable messaging
media. It never touches sessions, the state database, memories, credentials,
config, installed skills/plugins, backups, the cron control-plane, or another
profile — nor sandboxes, browser profiles, or worktrees, which can hold
persistent container/browser/uncommitted state. A runtime guard refuses any
target that falls outside the reclaimable allow-list. Rollback checkpoints are
reported but left to fabric checkpoints prune.
| Option | Description |
|---|---|
-y, --yes | Actually delete (default is a dry-run preview). |
-f, --force | With --yes, skip the confirmation prompt. Required to delete on a non-interactive terminal. |
--only CATEGORY … | Clean only these categories (cache, logs, traces, tmp, platforms). |
--skip CATEGORY … | Clean everything reclaimable except these categories. |
Examples
fabric disk usage # per-store breakdown + total + free space
fabric disk du --all # include empty categories
fabric disk usage --json # machine-readable
fabric disk clean # preview what would be reclaimed (dry-run)
fabric disk clean --yes # delete caches / rotated logs / traces / scratch
fabric disk clean --only cache --yes # just clear caches
fabric disk clean --skip logs --yes # everything reclaimable except logs
fabric monitor
fabric monitor [--interval SECONDS] [--once] [--json]
fabric top # alias
Live terminal view of this machine's health. Shares the same metrics collector as the web dashboard Host card and the desktop Command Center host panel, so CPU / memory / disk / load / network throughput / GPU utilization never drift across surfaces.
| Option | Description |
|---|---|
--interval SECONDS | Refresh period (default 2, minimum 0.5). |
--once | Print one frame and exit (also the behavior when stdout is not a TTY). |
--json | Emit one JSON sample (primes network counters briefly so rates are populated). |
Requires psutil for CPU, memory, disk, and network metrics (the psutil
extra). GPU metrics appear when pynvml is installed or nvidia-smi is on
PATH; otherwise those tiles are omitted.
fabric monitor # live TUI-style panel
fabric top --interval 1 # faster refresh
fabric monitor --once # single snapshot
fabric monitor --json # machine-readable sample
fabric import
fabric import <zipfile> [options]
Restore a previously created Fabric backup into your Fabric home directory. All files in the archive overwrite existing files in your Fabric home; --force only skips the confirmation prompt that fires when the target already has a Fabric installation.
| Option | Description |
|---|---|
-f, --force | Skip the existing-installation confirmation prompt. |
Stop the gateway before importing to avoid conflicts with running processes.
Examples
fabric import ~/fabric-backup-20260423.zip # Prompts before overwriting existing config
fabric import ~/fabric-backup-20260423.zip --force # Overwrite without prompting
fabric logs
fabric logs [log_name] [options]
View, tail, and filter Fabric log files. All logs are stored in ~/.fabric/logs/ (or <profile>/logs/ for non-default profiles).
Log files
| Name | File | What it captures |
|---|---|---|
agent (default) | agent.log | All agent activity — API calls, tool dispatch, session lifecycle (INFO and above) |
errors | errors.log | Warnings and errors only — a filtered subset of agent.log |
gateway | gateway.log | Messaging gateway activity — platform connections, message dispatch, webhook events |
gui | gui.log | Dashboard / TUI-gateway / PTY-bridge / websocket events |
desktop | desktop.log | Electron desktop app — boot, backend spawn output, and recent Python tracebacks |
Options
| Option | Description |
|---|---|
log_name | Which log to view: agent (default), errors, gateway, or list to show available files with sizes. |
-n, --lines <N> | Number of lines to show (default: 50). |
-f, --follow | Follow the log in real time, like tail -f. Press Ctrl+C to stop. |
--level <LEVEL> | Minimum log level to show: DEBUG, INFO, WARNING, ERROR, CRITICAL. |
--session <ID> | Filter lines containing a session ID substring. |
--since <TIME> | Show lines from a relative time ago: 30m, 1h, 2d, etc. Supports s (seconds), m (minutes), h (hours), d (days). |
--component <NAME> | Filter by component: gateway, agent, tools, cli, cron. |
Examples
# View the last 50 lines of agent.log (default)
fabric logs
# Follow agent.log in real time
fabric logs -f
# View the last 100 lines of gateway.log
fabric logs gateway -n 100
# Show only warnings and errors from the last hour
fabric logs --level WARNING --since 1h
# Filter by a specific session
fabric logs --session abc123
# Follow errors.log, starting from 30 minutes ago
fabric logs errors --since 30m -f
# List all log files with their sizes
fabric logs list
Filtering
Filters can be combined. When multiple filters are active, a log line must pass all of them to be shown:
# WARNING+ lines from the last 2 hours containing session "tg-12345"
fabric logs --level WARNING --since 2h --session tg-12345
Lines without a parseable timestamp are included when --since is active (they may be continuation lines from a multi-line log entry). Lines without a detectable level are included when --level is active.
Log rotation
Fabric uses Python's RotatingFileHandler. Old logs are rotated automatically — look for agent.log.1, agent.log.2, etc. The fabric logs list subcommand shows all log files including rotated ones.
fabric prompt-size
fabric prompt-size [--platform <name>] [--json]
Reports the fixed prompt budget for a fresh session — what gets sent on every API call before any conversation content. Useful when a downstream adapter or proxy has a tighter prompt budget than the model's context window, or when you want to see which block (skills index, memory, profile) dominates.
It builds the same system prompt the agent would, then breaks it down:
- System prompt total — full assembled prompt (identity, guidance, skills index, context files, memory, profile, timestamp).
- Skills index — the
<available_skills>block. This is often the largest single block when many skills are installed. - Memory and user profile — your
MEMORY.md/USER.mdsnapshots. - Prompt tiers — stable / context / volatile, matching how Fabric layers the prompt for cache-friendliness.
- Tool schemas — the JSON for all enabled tools (the other half of the fixed per-call payload).
Runs entirely offline — no API call, works with no credentials configured.
# Human-readable breakdown for the CLI platform (default)
fabric prompt-size
# Simulate a messaging platform's prompt (different platform hint)
fabric prompt-size --platform telegram
# Machine-readable output for scripts
fabric prompt-size --json
The skills index and tool schemas scale with how many skills and tools you have
enabled. To shrink the prompt, disable unused toolsets (fabric tools) or
uninstall skills you don't need (fabric skills). Context files (AGENTS.md,
.cursorrules) in your current directory also count toward the total.
fabric config
fabric config <subcommand>
Subcommands:
| Subcommand | Description |
|---|---|
show | Show current config values. |
edit | Open config.yaml in your editor. |
set <key> <value> | Set a config value. |
path | Print the config file path. |
env-path | Print the .env file path. |
check | Check for missing or stale config. |
migrate | Add newly introduced options interactively. |
fabric pairing
fabric pairing <list|approve|revoke|clear-pending>
| Subcommand | Description |
|---|---|
list | Show pending and approved users. |
approve <platform> <code> | Approve a pairing code. |
revoke <platform> <user-id> | Revoke a user's access. |
clear-pending | Clear pending pairing codes. |
fabric skills
fabric skills <subcommand>
Subcommands:
| Subcommand | Description |
|---|---|
browse | Paginated browser for skill registries. |
search | Search skill registries. |
install | Install a skill. |
inspect | Preview a skill without installing it. |
list | List installed skills. |
validate [target] | Read-only validation of SKILL.md and optional skill.contract.yaml. The target may be an installed skill name, a skill directory, or a directory containing skills; omit it to validate the active profile. |
evaluate <pending-id> --observations <path> | Run the data-only deterministic eval suite for an exact quarantined draft batch and persist a passing digest-bound attestation. |
rollback <transaction-id> [--now] | Restore a retained promotion snapshot only when the id is exact, active postdigests still match, and no newer promotion touches the same skills. Activation is deferred unless --now explicitly refreshes the shared skill index. |
check | Check installed hub skills for upstream updates. |
update | Reinstall hub skills with upstream changes when available. |
audit | Re-scan installed hub skills. |
gc | Recover interrupted Skills Hub transactions and prune one bounded batch of completed, digest-attested artifacts. Unverifiable records are retained for inspection. |
uninstall | Remove a hub-installed skill. |
reset | Un-stick a bundled skill flagged as user_modified by clearing its manifest entry. With --restore, also replaces the user copy with the bundled version. |
opt-out | Stop bundled skills from being seeded into the active profile. Writes a .no-bundled-skills marker so the installer, fabric update, and any sync skip bundled-skill seeding. Safe by default — nothing on disk is touched. With --remove, also deletes already-present bundled skills that are unmodified (user-edited, hub-installed, and hand-written skills are never removed; previews and confirms first, --yes to skip). |
opt-in | Undo opt-out by removing the .no-bundled-skills marker so bundled skills are seeded again on the next fabric update. With --sync, re-seed immediately. |
publish | Publish a skill to a registry. |
snapshot | Export/import skill configurations. |
tap | Manage custom skill sources. |
config | Interactive enable/disable configuration for skills by platform. |
Common examples:
fabric skills browse
fabric skills browse --source official
fabric skills search react --source skills-sh
fabric skills search https://mintlify.com/docs --source well-known
fabric skills inspect official/security/1password
fabric skills inspect skills-sh/vercel-labs/json-render/json-render-react
fabric skills install official/migration/openclaw-migration
fabric skills install skills-sh/anthropics/skills/pdf --force
fabric skills install https://sharethis.chat/SKILL.md # Direct URL (single-file SKILL.md)
fabric skills install https://example.com/SKILL.md --name my-skill # Override name when frontmatter has none
fabric skills validate github-pr-workflow
fabric skills validate ./skills/my-skill --require-contract
fabric skills validate --require-contract --json # Strict, deterministic CI output
fabric skills evaluate 0123456789abcdef0123456789abcdef --observations observations.json
fabric skills rollback 0123456789abcdef0123456789abcdef
fabric skills rollback 0123456789abcdef0123456789abcdef --now
fabric skills check
fabric skills update
fabric skills gc
fabric skills config
fabric skills reset google-workspace
fabric skills reset google-workspace --restore --yes
fabric skills opt-out # stop future bundled-skill seeding (nothing deleted)
fabric skills opt-out --remove --yes # also delete UNMODIFIED bundled skills
fabric skills opt-in --sync # undo: remove marker and re-seed now
Notes:
validateaccepts--require-contractto treat a missingskill.contract.yamlas an error and--jsonfor deterministic machine-readable output. It exits non-zero for invalid skills, unmatched targets, or missing contracts in strict mode.evaluatereads a bounded regular JSON file without following symlinks. Each observation has exactlyselected,output,tools,approvals, andoutcome_score; single-skill batches use the manifest case-id mapping directly, while multi-skill batches wrap exact skill names under{"skills": {...}}. It executes no model, provider, hook, command, or skill code; a failed or stale report cannot authorize promotion.rollbackaccepts exactly the 32-hex transaction id printed after promotion. It refuses stale rollback after an active-tree edit or a newer promotion, and it never bypasses snapshot retention checks. Restored routing activates on the next session by default;--nowrefreshes the shared index immediately and may forfeit a prompt-cache hit on the next request.--forcecan override non-dangerous policy blocks for third-party/community skills.--forcedoes not override adangerousscan verdict.--source skills-shsearches the publicskills.shdirectory.--source well-knownlets you point Fabric at a site exposing/.well-known/skills/index.json.--source browse-shsearches browse.sh's catalog of 200+ site-specific browser-automation skills. Identifiers look likebrowse-sh/airbnb.com/search-listings-ddgioa.- Passing an
http(s)://…/*.mdURL installs a single-file SKILL.md directly. When frontmatter has noname:and the URL slug isn't a valid identifier, an interactive terminal prompts for a name; non-interactive surfaces (/skills installinside the TUI, gateway platforms) require--name <x>instead.
fabric bundles
fabric bundles <subcommand>
Skill bundles group several skills under one /<bundle-name> slash command. Invoking the bundle loads every referenced skill into a single combined user message. Storage: ~/.fabric/skill-bundles/<slug>.yaml. See Skill Bundles for the YAML schema and behavior.
Subcommands:
| Subcommand | Description |
|---|---|
list | List installed bundles (default when no subcommand given) |
show <name> | Show one bundle's name, description, skills, and file path |
create <name> | Create a new bundle. Pass --skill <id> (repeat) or omit for interactive entry. --description, --instruction, --force available. |
delete <name> | Remove a bundle file |
reload | Re-scan ~/.fabric/skill-bundles/ and report added/removed bundles |
Examples:
fabric bundles create backend-dev \
--skill github-code-review \
--skill test-driven-development \
--skill github-pr-workflow \
-d "Backend feature work"
fabric bundles list
fabric bundles show backend-dev
fabric bundles delete backend-dev
In a chat session, /bundles lists installed bundles and /<bundle-name> loads one.
fabric curator
fabric curator <subcommand>
The curator is an auxiliary-model background task that periodically reviews agent-created skills, prunes stale ones, consolidates overlaps, and archives obsolete skills. Bundled and hub-installed skills are never touched. Archives are recoverable; auto-deletion never happens.
| Subcommand | Description |
|---|---|
status | Show curator status and skill stats |
run | Trigger a curator review now (blocks until the LLM pass finishes) |
run --background | Start the LLM pass in a background thread and return immediately |
run --dry-run | Preview only — produce the review report with no mutations |
backup | Take a manual tar.gz snapshot of ~/.fabric/skills/ (curator also snapshots automatically before every real run) |
rollback | Restore ~/.fabric/skills/ from a snapshot (defaults to newest) |
rollback --list | List available snapshots |
rollback --id <ts> | Restore a specific snapshot by id |
rollback -y | Skip the confirmation prompt |
pause | Pause the curator until resumed |
resume | Resume a paused curator |
pin <skill> | Pin a skill so the curator never auto-transitions it |
unpin <skill> | Unpin a skill |
restore <skill> | Restore an archived skill |
archive <skill> | Archive a skill manually |
prune | Manually prune skills the curator would normally clean up |
list-archived | List archived skills (recoverable via restore) |
On a fresh install the first scheduled pass is deferred by one full interval_hours (7 days by default) — the gateway will not curate immediately on the first tick after fabric update. Use fabric curator run --dry-run to preview before that happens.
See Curator for behavior and config.
fabric moa
Configure named Mixture of Agents presets. Presets appear as selectable models under a Mixture of Agents provider in every model picker; /moa <prompt> runs one prompt through the default preset.
fabric moa list
fabric moa configure [name]
fabric moa delete <name>
fabric moa configure reuses Fabric's provider → model picker for each reference model and the aggregator. A preset is an execution-mode configuration, not a primary model or provider.
fabric fallback
fabric fallback <subcommand>
Manage the fallback provider chain. Fallback providers are tried in order when the primary model fails with rate-limit, overload, or connection errors.
| Subcommand | Description |
|---|---|
list (alias: ls) | Show the current fallback chain (default when no subcommand) |
add | Pick a provider + model (same picker as fabric model) and append to the chain |
remove (alias: rm) | Pick an entry to delete from the chain |
clear | Remove all fallback entries |
See Fallback Providers.
fabric hooks
fabric hooks <subcommand>
Inspect shell-script hooks declared in ~/.fabric/config.yaml, test them against synthetic payloads, and manage the first-use consent allowlist at ~/.fabric/shell-hooks-allowlist.json.
| Subcommand | Description |
|---|---|
list (alias: ls) | List configured hooks with matcher, timeout, and consent status |
test <event> | Fire every hook matching <event> against a synthetic payload |
revoke (aliases: remove, rm) | Remove a command's allowlist entries (takes effect on next restart) |
doctor | Check each configured hook: exec bit, allowlist, mtime drift, JSON validity, and synthetic run timing |
See Hooks for event signatures and payload shapes.
fabric memory
fabric memory <subcommand>
Set up and manage Fabric memory provider plugins. Available bundled providers:
honcho, openviking, mem0, hindsight, holographic, retaindb, byterover, and
supermemory. User-installed providers also appear dynamically. Only one external
provider can be configured at a time. MEMORY.md and USER.md are controlled
independently by memory.memory_enabled and memory.user_profile_enabled.
Status reports static activation eligibility, never unobserved runtime
activation or live health.
Subcommands:
| Subcommand | Description |
|---|---|
setup | Interactive provider selection and configuration. |
status | Show tier state, configured provider, static readiness, adapter-potential capabilities, and controlled issues. It performs no live health probe. |
off | Disable the external provider without changing built-in tier settings. |
audit [--json] | Reconcile MEMORY.md/USER.md with the local governance sidecar. Reports duplicate digest groups, conservative conflict candidates, untracked/orphaned records, and review/expiry state without echoing memory text. |
revalidate <record-id> | Refresh review and expiry policy clocks for one current governed record. The change applies to new session snapshots. |
reset [--target all|memory|user] [--yes] | Erase the selected built-in memory files and remove all governance state (all) or safely prune only matching governance records. This does not delete external-provider data. |
When an external memory provider is configured, it may register its own top-level fabric <provider> command for provider-specific management (for example, fabric honcho). Run fabric --help to see what is currently wired in.
Inside the interactive CLI, TUI, desktop, or a messaging gateway, use:
/memory status # same read-only readiness summary
/memory pending # list staged built-in writes
/memory approve <id|all>
/memory reject <id|all>
/memory approval <on|off> # built-in writes only
Deleting local MEMORY.md/USER.md content does not guarantee erasure from an external provider, its replicas, or backups.
fabric acp
fabric acp
Starts Fabric as an ACP (Agent Client Protocol) stdio server for editor integration.
Install support first:
cd ~/.fabric/fabric-agent && uv pip install -e '.[acp]'
See ACP Editor Integration and ACP Internals.
fabric mcp
fabric mcp <subcommand>
Manage MCP (Model Context Protocol) server configurations and run Fabric as an MCP server.
| Subcommand | Description |
|---|---|
(none) or picker | Interactive catalog picker — browse Fabric-curated MCPs and install/enable/disable. |
catalog | List Fabric-curated MCPs (plain text, scriptable). |
install <name> | Install a catalog entry by its catalog name. |
serve [-v|--verbose] | Run Fabric as an MCP server — expose conversations to other agents. |
add <name> [--url URL] [--command CMD] [--auth oauth|header] [--args ...] | Add a custom MCP server with automatic tool discovery. --args passes the remaining argv to the stdio command, so put it last. |
remove <name> (alias: rm) | Remove an MCP server from config. |
list (alias: ls) | List configured MCP servers. |
test <name> | Test connection to an MCP server. |
configure <name> (alias: config) | Toggle tool selection for a server. |
login <name> | Force re-authentication for an OAuth-based MCP server. |
See MCP Config Reference, Use MCP with Fabric, and MCP Server Mode.
fabric plugins
fabric plugins [subcommand]
Unified plugin management — general plugins, memory providers, and context engines in one place. Running fabric plugins with no subcommand opens a composite interactive screen with two sections:
- General Plugins — multi-select checkboxes to enable/disable installed plugins
- Provider Plugins — single-select configuration for Memory Provider and Context Engine. Press ENTER on a category to open a radio picker.
| Subcommand | Description |
|---|---|
| (none) | Composite interactive UI — general plugin toggles + provider plugin configuration. |
install <identifier> [--force] | Install a plugin from a Git URL or owner/repo. |
update <name> | Pull latest changes for an installed plugin. |
remove <name> (aliases: rm, uninstall) | Remove an installed plugin. |
enable <name> | Enable a disabled plugin. |
disable <name> | Disable a plugin without removing it. |
list (alias: ls) | List installed plugins with enabled/disabled status. |
Provider plugin selections are saved to config.yaml:
memory.provider— selected external memory provider (empty = none)context.engine— active context engine ("compressor"= built-in default)
General plugin disabled list is stored in config.yaml under plugins.disabled.
See Plugins and Build a Fabric Plugin.
fabric tools
fabric tools [--summary]
| Option | Description |
|---|---|
--summary | Print the current enabled-tools summary and exit. |
Without --summary, this launches the interactive per-platform tool configuration UI.
fabric computer-use
fabric computer-use <subcommand>
Subcommands:
| Subcommand | Description |
|---|---|
install | Run the upstream cua-driver installer (macOS, Windows, and Linux). |
install --upgrade | Re-run the installer even if cua-driver is already on PATH. The upstream script always pulls the latest release, so this performs an in-place upgrade. |
status | Print whether cua-driver is on $PATH and which version is installed. |
fabric computer-use install is the stable entry point for installing the
cua-driver binary used by the
computer_use toolset. It runs the same upstream installer that
fabric tools invokes when you first enable Computer Use, so it's safe
to use for re-running the install if the toolset toggle didn't trigger
it (for example, on returning-user setups).
fabric update automatically re-runs the upstream installer at the end
of the update if cua-driver is on PATH, so most users will not need to
call --upgrade manually. Use it when upstream ships a fix you want
right now without waiting for the next Fabric update.
fabric pets
fabric pets <list|install|select|show|off|scale|remove|doctor>
Petdex is a public gallery of animated sprite pets for coding agents. Install one and Fabric shows it reacting to agent activity across the CLI, TUI, and desktop app.
| Subcommand | Description |
|---|---|
list | Browse the petdex gallery. |
install | Install a pet from the gallery. |
select | Set the active pet (writes display.pet.*). |
show | Animate the active pet in the terminal. |
off | Disable the pet display. |
scale | Resize the pet everywhere (display.pet.scale). |
remove | Delete an installed pet. |
doctor | Check pet setup + terminal graphics support. |
You can also generate a brand-new pet from a text description with the /hatch slash command. See Pets.
fabric sessions
fabric sessions <subcommand>
Subcommands:
| Subcommand | Description |
|---|---|
list | List recent sessions. |
browse | Interactive session picker with search and resume. |
export <output> [--session-id ID] | Export sessions to JSONL. |
delete <session-id> | Delete one session. |
prune | Delete sessions matching filters: time bounds --older-than/--newer-than/--before/--after (durations like 5h/2d, bare days, or ISO timestamps); attributes --source, --title, --model, --provider, --branch, --end-reason, --user, --chat-id, --chat-type, --cwd; numeric bounds --min/--max-messages, --min/--max-tokens, --min/--max-cost, --min/--max-tool-calls; plus --include-archived, --dry-run, --yes. Default: older than 90 days. |
archive | Bulk-archive (soft-hide, no deletion) sessions matching the same filters as prune. Requires at least one filter. |
stats | Show session-store statistics. |
rename <session-id> <title> | Set or change a session title. |
fabric insights
fabric insights [--days N] [--source platform]
| Option | Description |
|---|---|
--days <n> | Analyze the last n days (default: 30). |
--source <platform> | Filter by source such as cli, telegram, or discord. |
fabric claw
fabric claw migrate [options]
Migrate your OpenClaw setup to Fabric. Reads from ~/.openclaw (or a custom path) and writes to ~/.fabric. Automatically detects legacy directory names (~/.clawdbot, ~/.moltbot) and config filenames (clawdbot.json, moltbot.json).
| Option | Description |
|---|---|
--dry-run | Preview what would be migrated without writing anything. |
--preset <name> | Migration preset: full (all compatible settings) or user-data (excludes infrastructure config). Neither preset imports secrets — pass --migrate-secrets explicitly. |
--overwrite | Overwrite existing Fabric files on conflicts (default: refuse to apply when the plan has conflicts). |
--migrate-secrets | Include API keys in migration. Required even under --preset full. |
--no-backup | Skip the pre-migration zip snapshot of ~/.fabric/ (by default a single restore-point archive is written to ~/.fabric/backups/pre-migration-*.zip before apply; restorable with fabric import). |
--source <path> | Custom OpenClaw directory (default: ~/.openclaw). |
--workspace-target <path> | Target directory for workspace instructions (AGENTS.md). |
--skill-conflict <mode> | Handle skill name collisions: skip (default), overwrite, or rename. |
--yes | Skip the confirmation prompt. |
What gets migrated
The migration covers 30+ categories across persona, memory, skills, model providers, messaging platforms, agent behavior, session policies, MCP servers, TTS, and more. Items are either directly imported into Fabric equivalents or archived for manual review.
Directly imported: SOUL.md, MEMORY.md, USER.md, AGENTS.md, skills (4 source directories), default model, custom providers, MCP servers, messaging platform tokens and allowlists (Telegram, Discord, Slack, WhatsApp, Signal, Matrix, Mattermost), agent defaults (reasoning effort, compression, human delay, timezone, sandbox), session reset policies, approval rules, TTS config, browser settings, tool settings, exec timeout, command allowlist, gateway config, and API keys from 3 sources.
Archived for manual review: Cron jobs, plugins, hooks/webhooks, memory backend (QMD), skills registry config, UI/identity, logging, multi-agent setup, channel bindings, IDENTITY.md, TOOLS.md, HEARTBEAT.md, BOOTSTRAP.md.
API key resolution checks three sources in priority order: config values → ~/.openclaw/.env → auth-profiles.json. All token fields handle plain strings, env templates (${VAR}), and SecretRef objects.
For the complete config key mapping, SecretRef handling details, and post-migration checklist, see the full migration guide.
Examples
# Preview what would be migrated
fabric claw migrate --dry-run
# Full migration (all compatible settings, no secrets)
fabric claw migrate --preset full
# Full migration including API keys
fabric claw migrate --preset full --migrate-secrets
# Migrate user data only (no secrets), overwrite conflicts
fabric claw migrate --preset user-data --overwrite
# Migrate from a custom OpenClaw path
fabric claw migrate --source /home/user/old-openclaw
fabric serve
fabric serve [options]
Start the Fabric backend server — the JSON-RPC/WebSocket gateway the desktop app and remote clients connect to. It is the same server fabric dashboard runs, but headless: it never opens a browser UI. The desktop app launches its own fabric serve backend; use this command directly when you want a headless backend on a remote host. Accepts the same --host / --port / --insecure / --skip-build / --stop / --status options as fabric dashboard below (a non-loopback bind engages the same auth gate). Requires the [web] extra; the embedded Chat socket additionally needs [pty] on a POSIX host.
fabric dashboard
fabric dashboard [options]
Launch the web dashboard — a browser-based UI for managing configuration, API keys, and monitoring sessions. (For a headless backend with no browser UI — e.g. what the desktop app spawns — use fabric serve above.) Requires cd ~/.fabric/fabric-agent && uv pip install -e ".[web]" (FastAPI + Uvicorn). The embedded browser Chat tab is always available and additionally needs the pty extra (cd ~/.fabric/fabric-agent && uv pip install -e ".[web,pty]") plus a POSIX PTY environment such as Linux, macOS, or WSL2. See Web Dashboard for full documentation.
| Option | Default | Description |
|---|---|---|
--port | 9119 | Port to run the web server on |
--host | 127.0.0.1 | Bind address |
--no-open | — | Don't auto-open the browser |
--insecure | off | Deprecated / no-op. Formerly bypassed auth on a non-loopback bind. Since the June 2026 hardening a public bind always requires an auth provider (password or OAuth). Bind 127.0.0.1 and tunnel to keep it local. |
--skip-build | off | Skip the web UI build step and serve the existing dist directly. Useful for non-interactive contexts (Windows Scheduled Tasks, CI) where npm isn't available. Pre-build with cd web && npm run build. |
--isolated | off | When launched from a named profile (worker dashboard), run a dedicated per-profile server instead of routing to the machine dashboard. |
--stop | — | Stop running fabric dashboard processes and exit. |
--status | — | List running fabric dashboard processes and exit. |
fabric dashboard register
Register this install as a self-hosted dashboard with your Nous Portal account. Creates an OAuth client, writes dashboard.oauth.client_id into ~/.fabric/config.yaml, and prints how to engage the login gate. Requires being logged in (fabric setup).
| Option | Description |
|---|---|
--name | Human-readable label for the dashboard (default: auto-generated). |
--redirect-uri | Public HTTPS OAuth redirect URI (e.g. https://fabric.example.com/auth/callback). Omit for localhost-only use. |
--portal-url | Override the Nous Portal base URL for registration (default: the portal you logged into). |
# Default — opens browser to http://127.0.0.1:9119
fabric dashboard
# Custom port, no browser
fabric dashboard --port 8080 --no-open
# From a profile alias — routes to the machine dashboard with the
# profile preselected in the sidebar switcher (attach if running)
worker dashboard
fabric profile
fabric profile <subcommand>
Manage profiles — multiple isolated Fabric instances, each with its own config, sessions, skills, and home directory.
| Subcommand | Description |
|---|---|
list | List all profiles. |
use <name> | Set a sticky default profile. |
create <name> [--clone] [--clone-all] [--clone-from <source>] [--no-alias] | Create a new profile. --clone copies config, .env, SOUL.md, and skills from the active profile. --clone-all copies all state. --clone-from specifies a source profile and implies config clone unless paired with --clone-all. |
delete <name> [-y] | Delete a profile. |
show <name> | Show profile details (home directory, config, etc.). |
alias <name> [--remove] [--name NAME] | Manage wrapper scripts for quick profile access. |
rename <old> <new> | Rename a profile. |
export <name> [-o FILE] | Export a profile to a .tar.gz archive (local backup). |
import <archive> [--name NAME] | Import a profile from a .tar.gz archive (local restore). |
install <source> [--name N] [--alias] [--force] [-y] | Install a profile distribution from a git URL or local directory. |
update <name> [--force-config] [-y] | Re-pull a distribution; preserves user data (memories, sessions, auth). |
info <name> | Show a profile's distribution manifest (version, requirements, source). |
Examples:
fabric profile list
fabric profile create work --clone
fabric profile use work
fabric profile alias work --name h-work
fabric profile export work -o work-backup.tar.gz
fabric profile import work-backup.tar.gz --name restored
fabric profile install github.com/user/my-distro --alias
fabric profile update work
fabric -p work chat -q "Hello from work profile"
fabric completion
fabric completion [bash|zsh|fish]
Print a shell completion script to stdout. Source the output in your shell profile for tab-completion of Fabric commands, subcommands, and profile names.
Examples:
# Bash
fabric completion bash >> ~/.bashrc
# Zsh
fabric completion zsh >> ~/.zshrc
# Fish
fabric completion fish > ~/.config/fish/completions/fabric.fish
fabric update
fabric update [--gateway] [--check] [--no-backup] [--backup] [--yes]
Pulls the latest fabric-agent code and reinstalls dependencies in the managed venv, then re-runs the post-install hooks (MCP servers, skills sync, completion install). Safe to run on a live install. Use --check to see whether your checkout is behind origin/main without installing.
fabric update pulls the configured update branch (default: main). If your checkout is on another branch, Fabric may check out the update branch before pulling. Commit branch work before updating when you want to keep it outside the update autostash flow.
| Option | Description |
|---|---|
--gateway | Internal mode used by the messaging /update command. Uses file-based IPC for prompts and progress streaming instead of reading from terminal stdin. Not a gateway restart flag. |
--check | Check whether an update is available without pulling, installing dependencies, or restarting anything. |
--no-backup | Skip the pre-update backup for this run, even if updates.pre_update_backup is enabled in config.yaml. |
--backup | Create a labeled pre-update snapshot of FABRIC_HOME (config, auth, sessions, skills, pairing data) before pulling. Default is off — the previous always-backup behavior was adding minutes to every update on large homes. Flip it on permanently via updates.pre_update_backup: true in config.yaml. |
--yes, -y | Assume yes for interactive prompts such as config migration and stash restore. API-key entry is skipped; run fabric config migrate separately for those. |
Additional behavior:
- Gateway restart. After a successful update, Fabric attempts to restart all running gateway profiles automatically so they pick up the new code. Use
fabric gateway restartwhen you want to restart a gateway without applying an update. - Local source changes. For git installs, dirty tracked files and untracked files are auto-stashed before branch checkout or pull (
git stash push --include-untracked). Interactive terminal updates ask before restoring the stash. Non-interactive updates restore it by default; setupdates.non_interactive_local_changes: discardonly on managed installs where local source edits should be thrown away after a successful pull. If stash restore conflicts or the pull fails, the stash is left in place for manual recovery. - npm lockfile churn. Before stashing or switching branches, Fabric makes a best-effort cleanup of tracked
package-lock.jsondiffs produced by npm install/build steps. Commit or manually stash intentional lockfile edits before runningfabric update. - Pairing data snapshot. Even when
--backupis off,fabric updatetakes a lightweight snapshot of~/.fabric/platforms/pairing/and the Feishu comment rules beforegit pull. You can roll it back withfabric backup restore --state pre-updateif a pull rewrites a file you were editing. - Exit codes.
0on success,1on pull/install/post-install errors,2on unexpected working-tree changes that blockgit pull.
Maintenance commands
| Command | Description |
|---|---|
fabric version | Print version information. |
fabric update | Pull latest changes and reinstall dependencies. |
fabric postinstall | Internal bootstrap. Runs once after the install script provisions Fabric (or after fabric update) to install non-Python dependencies that pip cannot provide — Node.js runtime, headless browser, ripgrep, ffmpeg — and then trigger fabric setup if the profile has not been configured yet. Safe to re-run idempotently. |
fabric uninstall [--full] [--gui] [--yes] | Remove Fabric, optionally deleting all config/data. --gui removes only the desktop Chat GUI, leaving the agent intact; --full also deletes config/data; --yes skips prompts. |