sections cli

CLI

Active contributors: Andy Taylor, Sagar Narayan, Eno Reyes

Purpose

docs/cli/ is the largest section of the docs and covers Factory's command-line agent, droid. It's the entry point for most users — the install instructions on the landing page, the quickstart, the configuration reference, and the long tail of feature, BYOK, and account pages all live here.

Directory layout

docs/cli/
├── account/                  # Security, droid shield, droid shield plus
├── byok/                     # Bring-Your-Own-Key per provider
├── configuration/            # settings, AGENTS.md, skills, MCP, hooks, plugins, custom droids, custom slash commands, mixed models
├── droid-exec/               # Headless / non-interactive droid (overview lives here, recipes in guides/)
├── features/                 # missions, code-review, droid-control, droid-computers, readiness-report, wiki/
│   └── wiki/                 # overview, generate, web-viewer, auto-refresh
├── getting-started/          # overview, quickstart, common-use-cases, how-to-talk-to-a-droid, video-walkthrough
└── user-guides/              # become-a-power-user, specification-mode, auto-run, choosing-your-model, implementing-large-features

Highlights

Getting started

docs/cli/getting-started/overview.mdx is the page most users read first — it has the install snippets and a short pitch. quickstart.mdx is the 5-minute walkthrough. common-use-cases.mdx and how-to-talk-to-a-droid.mdx are the tone-and-pattern guides; video-walkthrough.mdx embeds a recorded walkthrough.

Configuration

The configuration tree is the densest area of the docs. The settings page (docs/cli/configuration/settings.mdx) is one of the highest-churn files in the repo. Adjacent pages cover the major extension points:

• agents-md.mdx — the project-level conventions file droid reads.
• skills.mdx — composable capabilities (with a parallel guide tree under docs/guides/skills/).
• mcp.mdx — Model Context Protocol servers.
• custom-droids.mdx — bespoke droids with role-specific prompts/tools.
• hooks-guide.mdx — pre/post tool-call hooks (full reference at docs/reference/hooks-reference.mdx).
• plugins.mdx — third-party packages of skills/hooks/droids.
• custom-slash-commands.mdx — repo-defined / commands.
• mixed-models.mdx — routing different tasks to different models.

Features

docs/cli/features/ is where new product capabilities land:

Page	What it covers
missions.mdx	Long-running scoped tasks droid plans and executes
code-review.mdx	The /review slash command and AI code review
droid-control.mdx	Orchestration of droid runs across machines
droid-computers.mdx	Managed cloud workspaces driven by droid
droid-computers-byom.mdx	The same, with a customer-supplied model
readiness-report.mdx	The CLI side of agent readiness
wiki/	The wiki feature (overview, generate, web-viewer, auto-refresh)

The wiki/ subdirectory documents the very feature that produced this wiki you're reading.

BYOK (Bring-Your-Own-Key)

docs/cli/byok/ has a per-provider page for every supported LLM gateway: Baseten, DeepInfra, Fireworks, Google Gemini, Groq, Hugging Face, Ollama, OpenAI/Anthropic direct, OpenRouter. The overview.mdx is the routing/decision page. Each provider page is short and recipe-style.

droid-exec

docs/cli/droid-exec/overview.mdx introduces the headless mode and is the only file in this subdirectory — recipe-level content lives in docs/guides/droid-exec/ (see Guides).

Account

docs/cli/account/ contains the security and Droid Shield pages that overlap with enterprise content. security.mdx is the public-facing security overview; droid-shield.mdx and droid-shield-plus.mdx describe the safety/guardrail tier.

User guides

docs/cli/user-guides/ has the power-user material:

• become-a-power-user.mdx
• specification-mode.mdx — spec-then-implement workflow
• auto-run.mdx — when droid runs without per-action approval
• choosing-your-model.mdx
• implementing-large-features.mdx

Key source files

File	Purpose
docs/cli/getting-started/overview.mdx	Landing page for new CLI users
docs/cli/getting-started/quickstart.mdx	5-minute install + first task walkthrough
docs/cli/configuration/settings.mdx	Highest-churn config page
docs/cli/configuration/agents-md.mdx	Project conventions file format
docs/cli/configuration/skills.mdx	Skills system reference
docs/cli/features/wiki/generate.mdx	The feature that produced this wiki
docs/cli/byok/overview.mdx	BYOK provider routing
docs/cli/droid-exec/overview.mdx	Headless mode introduction

Integration points

• Linked from the main README.md for the project.
• Configuration pages are referenced by docs/reference/cli-reference.mdx and vice versa.
• BYOK pages cross-link with docs/enterprise/models-llm-gateways-and-integrations.mdx.
• Wiki pages link to the feature on the live product surface.

Entry points for modification

• New CLI feature → add a page under docs/cli/features/ and a navigation entry in docs/docs.json's "Capabilities" or "Configure & Extend" group.
• New BYOK provider → copy an existing provider page in docs/cli/byok/, add to the BYOK group in docs.json, and update overview.mdx if needed.
• Settings changes → docs/cli/configuration/settings.mdx is the source of truth for user-facing settings; pair edits with docs/reference/cli-reference.mdx.