Skip to main content

Documentation Index

Fetch the complete documentation index at: https://factory-docs-academy-content-candidates.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Accessing settings

To configure droid settings:
  1. Run droid
  2. Enter /settings
  3. Adjust your preferences interactively
Changes take effect immediately and are saved to your settings file.

Where settings live

OSLocation
macOS / Linux~/.factory/settings.json
Windows%USERPROFILE%\.factory\settings.json
If the file doesn’t exist, it’s created with defaults the first time you run droid.

Local overrides

You can create a settings.local.json alongside settings.json in any .factory/ folder:
  • ~/.factory/settings.local.json (user-level)
  • <project>/.factory/settings.local.json (project-level)
Local overrides merge on top of the corresponding settings.json at the same level and follow the same hierarchy precedence. Add settings.local.json to .gitignore if you want to keep machine-specific preferences out of version control.

Legacy Droid YAML configuration

.droid.yaml was an older project configuration surface. Use the current .factory/ files instead:
  • Use settings.json and settings.local.json for Droid preferences and local overrides.
  • Use AGENTS.md for repository instructions, conventions, and validation commands.
  • Use MCP servers, hooks, and skills for integrations, automation, and reusable workflows.

Available settings

SettingOptionsDefaultDescription
modelopus, opus-4-7, opus-4-6, opus-4-6-fast, sonnet, sonnet-4-6, gpt-5.5, gpt-5.5-fast, gpt-5.5-pro, gpt-5.4, gpt-5.2, gpt-5.2-codex, gpt-5.3-codex, haiku, gemini-3.1-pro, gemini-3-flash, droid-core, glm-5.1, kimi-k2.5, kimi-k2.6, minimax-m2.7, custom-modelopusThe default AI model used by droid
reasoningEffortoff, none, low, medium, high (availability depends on the model)Model-dependent defaultControls how much structured thinking the model performs.
sessionDefaultSettings.interactionModeauto, specautoSets whether new sessions start in Auto or Spec Mode.
sessionDefaultSettings.autonomyLeveloff, low, medium, highoffSets the default Autonomy Level for new sessions.
cloudSessionSynctrue, falsetrueMirror CLI sessions to Factory web.
diffModegithub, unifiedgithubChoose between split GitHub-style diffs and a single-column view.
completionSoundoff, bell, fx-ok01, fx-ack01, or custom file pathfx-ok01Audio cue when a response finishes.
awaitingInputSoundoff, bell, fx-ok01, fx-ack01, or custom file pathfx-ack01Audio cue when droid is waiting for user input.
soundFocusModealways, focused, unfocusedalwaysWhen to play sound notifications.
commandAllowlistArray of commandsSafe defaults providedCommands that run without extra confirmation.
commandDenylistArray of commandsRestrictive defaults providedCommands that always require confirmation.
includeCoAuthoredByDroidtrue, falsetrueAutomatically append the Droid co-author trailer to commits.
enableDroidShieldtrue, falsetrueEnable secret scanning and git guardrails.
hooksDisabledtrue, falsefalseGlobally disable all hooks execution.
ideAutoConnecttrue, falsefalseAuto-connect to IDE from external terminals.
showThinkingInMainViewtrue, falsefalseDisplay AI thinking/reasoning blocks in the main chat view.
customModelsArray of model configs[]Custom model configurations for BYOK. See BYOK docs.

Model

Choose the default AI model that powers your droid:
  • opus - Claude Opus 4.5 (current default)
  • opus-4-7 - Claude Opus 4.7, newest flagship with Max reasoning (2×; 1× promotional until April 30)
  • opus-4-6 - Claude Opus 4.6, previous flagship with Max reasoning
  • opus-4-6-fast - Claude Opus 4.6 Fast, tuned for faster responses
  • sonnet - Claude Sonnet 4.5, balanced cost and quality
  • sonnet-4-6 - Claude Sonnet 4.6, Max reasoning at the Sonnet price point
  • gpt-5.5 - GPT-5.5, latest OpenAI flagship model with 1M context and Extra High reasoning
  • gpt-5.5-fast - GPT-5.5 on priority service tier, less susceptible to traffic surge
  • gpt-5.5-pro - GPT-5.5 Pro, higher-capability variant, ideal for research tasks
  • gpt-5.4 - GPT-5.4, previous OpenAI model with 922K context and Extra High reasoning
  • gpt-5.2 - OpenAI GPT-5.2
  • gpt-5.2-codex - GPT-5.2-Codex, OpenAI coding model with Extra High reasoning
  • gpt-5.3-codex - GPT-5.3-Codex, latest OpenAI coding model with Extra High reasoning and verbosity support
  • haiku - Claude Haiku 4.5, fast and cost-effective
  • gemini-3.1-pro - Gemini 3.1 Pro
  • gemini-3-flash - Gemini 3 Flash, fast and cheap (0.2× multiplier)
  • droid-core - GLM-5.1 open-source model
  • glm-5.1 - GLM-5.1 open-source model
  • kimi-k2.5 - Kimi K2.5 open-source model with image support
  • kimi-k2.6 - Kimi K2.6 open-source model with image support and optional High reasoning
  • minimax-m2.7 - MiniMax M2.7 open-source model with reasoning support for cost-sensitive agentic workflows
  • custom-model - Your own configured model via BYOK
You can also add custom models and BYOK.

Reasoning effort

reasoningEffort adjusts how much structured thinking the model performs before replying. Available values depend on the model, but typically include:
  • off / none – disable structured reasoning (fastest).
  • low, medium, high – progressively increase deliberation time for more complex reasoning.
Anthropic models default to off, while GPT-5 starts on medium.

Autonomy level

Use sessionDefaultSettings.interactionMode to choose whether new sessions start in Auto or Spec Mode, and sessionDefaultSettings.autonomyLevel to set the default Autonomy Level. off keeps manual approvals; low, medium, and high pre-authorize work at or below that risk level. sessionDefaultSettings.autonomyMode is deprecated and retained for older configurations.

Diff mode

Control how droid displays code changes:
  • github – Side-by-side, higher fidelity render (recommended).
  • unified – Traditional single-column diff format.

Cloud session sync

When this switch is on, every CLI session is mirrored to Factory web so you can revisit conversations in the browser:
  • true – Sync sessions to the web app.
  • false – Keep sessions local only.

Sound notifications

Configure audio feedback for droid events: Completion sound (completionSound) - plays when a response finishes:
  • fx-ok01 – Built-in completion sound (default) - soft success bloop
  • fx-ack01 – Alternative built-in sound effect - tactile ripple feedback
  • bell – Use the system terminal bell
  • off – No sound notifications
  • Custom path – Provide a file path to your own sound file (e.g., "/path/to/sound.wav")
Awaiting input sound (awaitingInputSound) - plays when droid is waiting for user input. Same options as completion sound, defaults to fx-ack01. Sound focus mode (soundFocusMode) - controls when sounds play:
  • always – Play sounds regardless of window focus (default)
  • focused – Only play sounds when the terminal is focused
  • unfocused – Only play sounds when the terminal is not focused
Access sound settings via /settings or Shift+TabSettings in the TUI.

Hooks

The hooksDisabled setting provides a global toggle to disable all hooks execution without removing your hook configurations:
  • false – Hooks are enabled and will execute normally (default)
  • true – All hooks are disabled globally
You can also toggle this from the /hooks menu or /settings.

IDE auto-connect

The ideAutoConnect setting controls whether droid automatically connects to your IDE when running from external terminals (outside the IDE’s built-in terminal):
  • false – Only auto-connect when running inside IDE terminal (default)
  • true – Auto-connect to IDE from any terminal

Command allowlist & denylist

Use these settings to control which commands droid can execute automatically and which it must never run:
  • commandAllowlist – Commands in this array are treated as safe and run without additional confirmation, regardless of autonomy prompts. Include only low-risk utilities you rely on frequently (for example ls, pwd, dir).
  • commandDenylist – Commands in this array always require confirmation and are typically blocked because they are destructive or unsafe (for example recursive rm, mkfs, or privileged system operations).
Commands that appear in both lists default to the denylist behavior. Any command that is in neither list falls back to the autonomy level you selected for the session.

Example allow/deny configuration

{
  "commandAllowlist": ["ls", "pwd", "dir"],
  "commandDenylist": ["rm -rf /", "mkfs", "shutdown"]
}
Review and update these arrays periodically to match your workflow and security posture, especially when sharing configurations across teams.

Example configuration

{
  "model": "opus",
  "reasoningEffort": "low",
  "diffMode": "github",
  "cloudSessionSync": true,
  "completionSound": "fx-ok01",
  "awaitingInputSound": "fx-ack01",
  "soundFocusMode": "always"
}

Need more?