# Factory Documentation

## Docs

- [Create a machine template](https://docs.factory.ai/api-reference/machine-templates/create-a-machine-template.md): Creates a new machine template with the specified repository and configuration.
- [Delete a machine template](https://docs.factory.ai/api-reference/machine-templates/delete-a-machine-template.md): Permanently deletes a machine template and all associated resources.
- [Get a machine template](https://docs.factory.ai/api-reference/machine-templates/get-a-machine-template.md): Returns details of a specific machine template.
- [List machine templates](https://docs.factory.ai/api-reference/machine-templates/list-machine-templates.md): Returns a paginated list of machine templates for the authenticated organization.
- [Update a machine template](https://docs.factory.ai/api-reference/machine-templates/update-a-machine-template.md): Updates an existing machine template configuration.
- [Get global user token limit](https://docs.factory.ai/api-reference/organization/get-global-user-token-limit.md): Returns the global per-user token limit for the organization. This limit applies to all users who do not have an individual override.
- [Get user token limits](https://docs.factory.ai/api-reference/organization/get-user-token-limits.md): Returns the global per-user token limit and any individual user overrides for the organization.
- [List enterprise control change history](https://docs.factory.ai/api-reference/organization/list-enterprise-control-change-history.md): Returns a paginated list of enterprise control setting changes for the organization, ordered by revision descending.
- [List organization users](https://docs.factory.ai/api-reference/organization/list-organization-users.md): Returns a paginated list of users in the Factory organization.
- [Set global user token limit](https://docs.factory.ai/api-reference/organization/set-global-user-token-limit.md): Set the global per-user token limit for the organization. This limit applies to all users who do not have an individual override. Pass null to remove the global limit.
- [Set user token limits](https://docs.factory.ai/api-reference/organization/set-user-token-limits.md): Set individual per-user token limits for one or more users. Supports bulk updates (up to 100 users per request). Identify each user by email. Pass null for limit to remove an individual override.
- [Factory Release 1.10](https://docs.factory.ai/changelog/1-10.md): MCP Manager, custom completion sounds, and Droid hooks
- [Factory Release 1.8](https://docs.factory.ai/changelog/1-8.md): Headless CLI, Slack and Linear integrations
- [Factory Release 1.9](https://docs.factory.ai/changelog/1-9.md): Mixed models, custom subagents, and GitHub PR reviews
- [Release notes](https://docs.factory.ai/changelog/release-notes.md): Recent features and improvements to Factory CLI
- [Droid Shield](https://docs.factory.ai/cli/account/droid-shield.md): Automatic secret detection to prevent accidental exposure of credentials in your git commits and pushes.
- [Droid Shield Plus](https://docs.factory.ai/cli/account/droid-shield-plus.md): AI-powered security scanning for prompt injection, secrets detection, and sensitive data protection. Enterprise feature powered by Palo Alto Networks Prisma AIRS.
- [Security](https://docs.factory.ai/cli/account/security.md): How Factory CLI keeps your code and data secure with built-in protections and best practices.
- [Baseten](https://docs.factory.ai/cli/byok/baseten.md): Deploy and serve custom models with enterprise-grade infrastructure
- [DeepInfra](https://docs.factory.ai/cli/byok/deepinfra.md): Cost-effective inference for a wide variety of open-source models
- [Fireworks AI](https://docs.factory.ai/cli/byok/fireworks.md): High-performance inference for open-source models with optimized serving
- [Google Gemini](https://docs.factory.ai/cli/byok/google-gemini.md): Access Google's Gemini models using your Gemini AI API key
- [Groq](https://docs.factory.ai/cli/byok/groq.md): Ultra-fast inference with Groq's LPU™ Inference Engine
- [Hugging Face](https://docs.factory.ai/cli/byok/huggingface.md): Connect to models hosted on Hugging Face's Inference Providers
- [Ollama](https://docs.factory.ai/cli/byok/ollama.md): Run models locally on your hardware or use Ollama Cloud
- [OpenAI & Anthropic](https://docs.factory.ai/cli/byok/openai-anthropic.md): Use your own API keys for official OpenAI and Anthropic models
- [OpenRouter](https://docs.factory.ai/cli/byok/openrouter.md): Access models from multiple providers through a unified interface
- [Bring Your Own Key (BYOK)](https://docs.factory.ai/cli/byok/overview.md): Connect your own API keys, use open source models, or run local models
- [AGENTS.md](https://docs.factory.ai/cli/configuration/agents-md.md): Teach agents everything they need to know about your project with a single Markdown file.
- [Custom Droids (Subagents)](https://docs.factory.ai/cli/configuration/custom-droids.md): Create specialized subagents with their own prompts, tool access, and models that droid can delegate work to.
- [Custom Slash Commands](https://docs.factory.ai/cli/configuration/custom-slash-commands.md): Extend the CLI with reusable Markdown prompts or executable scripts that run from the chat input.
- [Hooks](https://docs.factory.ai/cli/configuration/hooks-guide.md): Learn how to customize and extend Droid's behavior by registering shell commands
- [Model Context Protocol (MCP)](https://docs.factory.ai/cli/configuration/mcp.md): Connect your own tools with Model Context Protocol
- [Mixed Models](https://docs.factory.ai/cli/configuration/mixed-models.md): Use a different AI model for Specification Mode planning than your default model for maximum flexibility and optimization.
- [Plugins](https://docs.factory.ai/cli/configuration/plugins.md): Extend Droid with shareable packages of skills, commands, and tools.
- [Settings](https://docs.factory.ai/cli/configuration/settings.md): Configure how droid behaves and integrates with your workflow.
- [Skills](https://docs.factory.ai/cli/configuration/skills.md): Reusable capabilities that your AI agent invokes on demand.
- [Droid Exec (Headless)](https://docs.factory.ai/cli/droid-exec/overview.md): Non-interactive execution mode for CI/CD pipelines and automation scripts.
- [Code Review](https://docs.factory.ai/cli/features/code-review.md): Use the /review command to analyze code changes with AI-powered review workflows
- [Droid Computers (Research Preview)](https://docs.factory.ai/cli/features/droid-computers.md): Persistent, long-lived compute environments for Droid
- [Missions](https://docs.factory.ai/cli/features/missions.md): Plan and execute large, multi-feature projects with structured orchestration. Describe your goal, collaborate on the plan, and let Droid manage the work.
- [Slash Command](https://docs.factory.ai/cli/features/readiness-report.md): Evaluate your repository's autonomy maturity with the /readiness-report slash command.
- [Common Use Cases](https://docs.factory.ai/cli/getting-started/common-use-cases.md): Practical, day‑one workflows you can run in the interactive terminal UI.
- [How to Talk to a Droid](https://docs.factory.ai/cli/getting-started/how-to-talk-to-a-droid.md): Proven techniques for writing prompts that get high-quality results from Factory's AI agents.
- [Overview](https://docs.factory.ai/cli/getting-started/overview.md): Meet `droid` — the power of Factory in your terminal
- [Quickstart](https://docs.factory.ai/cli/getting-started/quickstart.md): Get productive with droid in 5 minutes using the interactive terminal UI.
- [Video Walkthrough](https://docs.factory.ai/cli/getting-started/video-walkthrough.md): A video tutorial covering installation, configuration, and all key features of the Droid CLI
- [Auto-Run Mode](https://docs.factory.ai/cli/user-guides/auto-run.md): Choose low, medium, or high autonomy so droid can execute work that matches your risk tolerance without repeated confirmations.
- [Become a Power User](https://docs.factory.ai/cli/user-guides/become-a-power-user.md): Maximize Droid performance with IDE integration, smart planning, and project optimization.
- [Choosing Your Model](https://docs.factory.ai/cli/user-guides/choosing-your-model.md): Balance accuracy, speed, and cost by picking the right model and reasoning level for each CLI task.
- [Implementing Large Features](https://docs.factory.ai/cli/user-guides/implementing-large-features.md): A systematic approach to tackling complex, multi-phase development projects using specification planning and iterative implementation.
- [Specification Mode](https://docs.factory.ai/cli/user-guides/specification-mode.md): Turn plain-English specifications into production-ready code with automatic planning and review.
- [Compliance, Audit & Monitoring](https://docs.factory.ai/enterprise/compliance-audit-and-monitoring.md): How Droids support SOC2, ISO 27001/42001, regulatory reviews, and continuous monitoring using OpenTelemetry and audit logs.
- [Enterprise Plugin Registry](https://docs.factory.ai/enterprise/enterprise-plugin-registry.md): Centralize and distribute approved plugins across your organization with a private plugin marketplace.
- [GitHub Integration Security](https://docs.factory.ai/enterprise/github-integration-security.md): Security architecture, data flows, and controls for the Factory Droid GitHub Action integration.
- [Hierarchical Settings & Org Control](https://docs.factory.ai/enterprise/hierarchical-settings-and-org-control.md): How org, project, folder, and user settings combine to control models, tools, safety policies, and telemetry for Droid.
- [Identity & Access Management](https://docs.factory.ai/enterprise/identity-and-access.md): How Droids use org, project, and user identity to control who can run agents, where, and with which permissions.
- [Identity, Domains, SSO, and SCIM](https://docs.factory.ai/enterprise/identity-sso-and-scim.md): Enterprise identity management with Domain Managment, SSO/SAML authentication, and Directory Sync/SCIM provisioning
- [Enterprise with Droids](https://docs.factory.ai/enterprise/index.md): How to deploy, secure, and operate Droids in the world’s highest‑security environments.
- [LLM Safety & Agent Controls](https://docs.factory.ai/enterprise/llm-safety-and-agent-controls.md): How Droids classify risk, enforce allow/deny policies, use Droid Shield, and integrate hooks and sandboxes to keep agents safe.
- [Models, LLM Gateways & Integrations](https://docs.factory.ai/enterprise/models-llm-gateways-and-integrations.md): How Droids connect to your models, LLM gateways, MCP servers, droids, commands, and existing engineering tools.
- [Network & Deployment Configuration](https://docs.factory.ai/enterprise/network-and-deployment.md): Reference architectures and network requirements for cloud, hybrid, and fully airgapped Droid deployments.
- [Privacy, Data Flows & Governance](https://docs.factory.ai/enterprise/privacy-and-data-flows.md): How code, prompts, and telemetry move in cloud, hybrid, and fully airgapped Droid deployments, and how to control those flows.
- [Telemetry Export (OTEL)](https://docs.factory.ai/enterprise/telemetry-export.md): Export OpenTelemetry metrics from Droid to your own OTLP-compatible collector for full visibility in your existing observability stack.
- [Usage, Cost & Productivity Analytics](https://docs.factory.ai/enterprise/usage-cost-and-analytics.md): How to measure Droid adoption, control LLM spend, and understand impact using OpenTelemetry and optional Factory dashboards.
- [Building Plugins](https://docs.factory.ai/guides/building/building-plugins.md): Create shareable plugins with skills, commands, and tools for Droid.
- [Building Interactive Apps with Droid Exec](https://docs.factory.ai/guides/building/droid-exec-tutorial.md): Learn how to build a chat with X feature using Droid Exec
- [Deploy Droid on a VPS Server](https://docs.factory.ai/guides/building/droid-vps-setup.md): Learn how to set up droid on a VPS for remote access and headless automation
- [Automated Code Review](https://docs.factory.ai/guides/droid-exec/code-review.md): Set up automated pull request reviews using the Factory GitHub App
- [Automated Documentation](https://docs.factory.ai/guides/droid-exec/document-automation.md): Automatically update documentation when code changes using CI/CD workflows
- [GitHub Actions](https://docs.factory.ai/guides/droid-exec/github-actions.md): Ready-to-use GitHub Actions workflows with droid exec.
- [Improve Error Messages](https://docs.factory.ai/guides/droid-exec/refactor-error-messages.md): Automatically improve Error messages across your entire codebase using Droid Exec
- [Automated Lint Fixes](https://docs.factory.ai/guides/droid-exec/refactor-fix-lint.md): Automatically fix ESLint violations across your codebase using Droid Exec
- [Organize Imports](https://docs.factory.ai/guides/droid-exec/refactor-imports.md): Automatically organize imports across your entire codebase using Droid Exec
- [Auto-formatting Code](https://docs.factory.ai/guides/hooks/auto-formatting.md): Automatically format code after every file edit using hooks
- [Code Validation Hooks](https://docs.factory.ai/guides/hooks/code-validation.md): Enforce code standards, security policies, and best practices automatically
- [Documentation Sync](https://docs.factory.ai/guides/hooks/documentation-sync.md): Keep documentation in sync with code changes automatically
- [Git Workflow Hooks](https://docs.factory.ai/guides/hooks/git-workflows.md): Integrate hooks with Git for commit validation, branch protection, and automated workflows
- [Logging and Analytics](https://docs.factory.ai/guides/hooks/logging-analytics.md): Track Droid usage, collect metrics, and analyze development patterns with hooks
- [Custom Notifications](https://docs.factory.ai/guides/hooks/notifications.md): Get notified when Droid needs attention using desktop alerts, sounds, Slack, and more
- [Session Automation](https://docs.factory.ai/guides/hooks/session-automation.md): Automate session setup with context loading, environment configuration, and dependency management
- [Testing Automation](https://docs.factory.ai/guides/hooks/testing-automation.md): Automate test execution, coverage tracking, and test result validation with hooks
- [Evaluating Context Compression](https://docs.factory.ai/guides/power-user/evaluating-context-compression.md): Summary of Factory Research’s evaluation of context compression strategies for long-running AI agent sessions.
- [Memory and Context Management](https://docs.factory.ai/guides/power-user/memory-management.md): Build persistent memory so Droid remembers your preferences, decisions, and project history across sessions.
- [Prompt Crafting for Different Models](https://docs.factory.ai/guides/power-user/prompt-crafting.md): Model-specific prompting techniques to get better results from Claude, GPT, and other models.
- [Rules and Conventions](https://docs.factory.ai/guides/power-user/rules-conventions.md): Organize coding standards and team conventions so Droid follows them consistently across all work.
- [Power User Setup Checklist](https://docs.factory.ai/guides/power-user/setup-checklist.md): Complete checklist to configure Droid for maximum effectiveness with IDE integration, memory, skills, and automation.
- [Token Efficiency Strategies](https://docs.factory.ai/guides/power-user/token-efficiency.md): Reduce token usage while maintaining quality through project setup, model selection, and workflow optimization.
- [AI data analyst skill](https://docs.factory.ai/guides/skills/ai-data-analyst.md): A reusable skill for performing comprehensive data analysis, visualization, and statistical modeling using code-interpreter style workflows.
- [Browser automation skill](https://docs.factory.ai/guides/skills/browser.md): Minimal Chrome DevTools Protocol helpers that let Droids start Chrome, navigate tabs, evaluate JavaScript, take screenshots, and capture DOM metadata without building a full MCP server.
- [Internal data querying skill](https://docs.factory.ai/guides/skills/data-querying.md): A reusable skill for safely querying internal analytics and data services and producing shareable, reproducible artifacts.
- [Frontend UI integration skill](https://docs.factory.ai/guides/skills/frontend-ui-integration.md): A reusable skill for implementing typed, tested frontend workflows against existing backend APIs in enterprise codebases.
- [Internal tools skill](https://docs.factory.ai/guides/skills/internal-tools.md): A reusable skill for building and extending internal tools that support engineers, operators, and support teams.
- [Product management AI skill](https://docs.factory.ai/guides/skills/product-management.md): A reusable skill for assisting with product management workflows including PRDs, feature analysis, roadmap planning, and user research synthesis.
- [Service integration skill](https://docs.factory.ai/guides/skills/service-integration.md): A reusable skill for extending existing services and wiring integrations in complex enterprise codebases.
- [Vibe coding skill](https://docs.factory.ai/guides/skills/vibe-coding.md): A reusable skill for rapidly prototyping and building modern web applications from scratch with a creative, experimental approach.
- [GitHub App](https://docs.factory.ai/integrations/github-app.md): Use the /install-github-app command to set up Droid integration with your GitHub repositories
- [IDE Integrations](https://docs.factory.ai/integrations/ide-integrations.md): Run droid directly inside your editor for richer context and a smoother workflow.
- [JetBrains IDEs](https://docs.factory.ai/integrations/jetbrains.md): Use Factory Droid as an AI agent inside JetBrains IDEs via ACP.
- [Linear](https://docs.factory.ai/integrations/linear.md): Guide to connect Factory with your Linear workspace
- [Slack](https://docs.factory.ai/integrations/slack.md): Step-by-step guide to connect Factory with your Slack workspace
- [Zed](https://docs.factory.ai/integrations/zed.md): Use Factory Droid as a custom AI agent inside Zed, with full MCP server support.
- [Leaderboards](https://docs.factory.ai/leaderboards/index.md): Benchmarks and evaluations for AI coding agents
- [Pricing & Models](https://docs.factory.ai/pricing.md): Model pricing in Standard Tokens
- [Analytics API](https://docs.factory.ai/reference/analytics-api.md): REST API for organization-level usage metrics, token consumption, tool usage, and productivity analytics.
- [CLI Reference](https://docs.factory.ai/reference/cli-reference.md): Complete reference for droid command-line interface, including commands and flags
- [Hooks reference](https://docs.factory.ai/reference/hooks-reference.md): Reference documentation for implementing hooks in Droid
- [Readiness Reports API](https://docs.factory.ai/reference/readiness-reports-api.md): REST API reference for programmatic access to agent readiness reports.
- [Support](https://docs.factory.ai/support.md): Get help from the Factory team
- [Readiness Dashboard](https://docs.factory.ai/web/agent-readiness/dashboard.md): Track and analyze your organization's Agent Readiness scores in the Factory app.
- [Overview](https://docs.factory.ai/web/agent-readiness/overview.md)
- [Overview](https://docs.factory.ai/web/getting-started/overview.md): If it can be done on a computer, it can be done with a Droid.
- [Quickstart](https://docs.factory.ai/web/getting-started/quickstart.md): Get up and running with the Factory App in 5 minutes
- [Cloud Templates - Best Practices](https://docs.factory.ai/web/machine-connection/cloud-templates/best-practices.md): Proven tips and workflows to get the most out of cloud templates in Factory
- [Cloud Templates](https://docs.factory.ai/web/machine-connection/cloud-templates/index.md): Spin-up instant, cloud-hosted templates that mirror your local dev setup. No install required
- [Cloud Templates – Installation & Usage](https://docs.factory.ai/web/machine-connection/cloud-templates/installation-and-usage.md): Set up, connect to, and use Cloud Templates inside Factory sessions
- [Cloud Templates – Setup Script](https://docs.factory.ai/web/machine-connection/cloud-templates/setup-script.md): Configure a setup script to run during template creation
- [Cloud Templates – Troubleshooting](https://docs.factory.ai/web/machine-connection/cloud-templates/troubleshooting.md): Diagnose and resolve common problems when creating, connecting to, or working inside a cloud template
- [Welcome to Factory](https://docs.factory.ai/welcome/index.md)

## OpenAPI Specs

- [openapi](https://api.factory.ai/api/v0/openapi.json)

## Optional

- [GitHub](https://github.com/factory-ai/factory)
- [Discord](https://discord.gg/zuudFXxg69)


Built with [Mintlify](https://mintlify.com).