Factory Droid CLI
Factory Droid CLI tutorial — install and configure an AI software engineering assistant and connect to New API. Automate the full development workflow from planning to testing.
Project Overview
Droid CLI is a command-line tool developed by Factory AI, designed to run as an AI software engineering agent. It allows users to interact with various large language models through the terminal to build, debug, and refactor code, and even create complete applications.
- Official homepage: https://factory.ai/product/cli
- Official documentation: https://docs.factory.ai/cli/getting-started/quickstart
Demo
Features
| Category | Feature | Value/Capability | Example/Notes |
|---|---|---|---|
| Quick Start & CLI | Install in 30 seconds; start a droid interactive session in a project directory; supports macOS/Linux and Windows | Quickly connect to your current project without new tools | Windows install: irm https://app.factory.ai/cli/windows | iex; launch: droid |
| End-to-End Feature Development | Full workflow automation from planning to implementation to testing; transparent review process | Improve delivery speed while keeping humans in control | Native diff viewing and approval workflow (see "Transparency and Control") |
| Deep Codebase Understanding | Combines shared organizational knowledge across codebases, documentation, and issue tracking; context-aware and improves over time | More accurate suggestions and changes | Continuously leverages knowledge across repositories and documentation |
| Engineering System Integration | Native integrations with Jira, Notion, Slack, and more; keeps development work aligned with team workflows | Reduce tool switching and information silos | "And more" indicates additional integrations are available |
| Production-Grade Automation | Workflows can be reused locally and in CI/CD; enterprise-grade security and compliance built in | Consistency and auditability | Suitable for pipelines and enterprise environments |
| Enterprise Capabilities | Private deployment options, SOC-2 compliance, and air-gapped environments | Meets security and compliance requirements | Security and quality first |
| Enhances Existing Tools | Works in the terminal, IDE, and existing development environments; no need to switch editors or learn a new UI | Preserve existing workflows with low migration cost | Deep integration with familiar tools |
| Transparency and Control | Every decision is visible and reviewable; maintain full oversight of code changes; native diff viewing and approval workflows | Reduce risk and improve control | Review-friendly and traceable |
| Model Flexibility | No lock-in to a single AI provider; choose the best model for each task; organization-wide consistent behavior and memory | Optimize for both performance and cost | Supports multi-model routing |
| Next Steps & Resources | Quickstart, Common Use Cases, IDE Integration, Configuration, AGENTS.md | Easier adoption and hands-on use | See the page section "Next steps/Additional resources" |
AI Model Configuration
Windows Step-by-Step Guide
1. Open a terminal
2. Install Factory Droid CLI
Official one-click install command:
One-Click Install Command
irm https://app.factory.ai/cli/windows | iex
3. Modify the configuration file
To use a third-party API with Droid CLI, you need to modify the configuration file.
Modify Environment Variables
iex (irm 'https://raw.githubusercontent.com/QuantumNous/new-api-docs/refs/heads/main/helper/factory-cli-setup.ps1')4. Start using Droid CLI
You can now start using Droid CLI.
Launch Droid CLI
Launch Droid CLI directly:
droidUse it in a specific project:
# Go to your project directory
cd C:\path\to\your\project
# Launch Droid CLI
droidPress Enter to launch Droid CLI.
Droid CLI requires users to sign in with an official account (free) before it can be used.
5. Common Windows troubleshooting
permission denied error during installation
This is usually a permissions issue. Try the following solutions:
- Run PowerShell as Administrator
- Or configure
npmto use the user directory:npm config set prefix %APPDATA%\npm
PowerShell execution policy error
If you encounter execution policy restrictions, run:
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUsermacOS/Linux Step-by-Step Guide
1. Install Droid CLI
Install Droid CLI
Open a terminal and run the following command:
curl -fsSL https://app.factory.ai/cli | sh
Follow the installation prompt to modify environment variables (just copy the command shown in the installation prompt):
On Linux, choose either ~/.bashrc or ~/.zshrc as appropriate.
Droid CLI Environment Variables (Example Only)
echo 'export PATH=/Users/修改此处/.local/bin:$PATH' >> ~/.zshrc
source ~/.zshrc2. Modify the configuration file
To use a third-party API with Droid CLI, you need to modify the configuration file.
One-click configuration file update
curl -fsSL https://raw.githubusercontent.com/QuantumNous/new-api-docs/refs/heads/main/helper/factory-cli-setup.sh | bash
3. Start using Droid CLI
You can now start using Droid CLI.
Launch Droid CLI
Launch Droid CLI directly:
droidUse it in a specific project:
# Go to your project directory
cd /path/to/your/project
# Launch Droid CLI
droidPress Enter to launch Droid CLI.
Droid CLI requires users to sign in with an official account (free) before it can be used.
How is this guide?
Last updated on
OpenAI Codex CLI
OpenAI Codex CLI installation guide — install a terminal-based AI coding assistant on Windows, macOS, and Linux, connected to New API. Supports sandbox policies and atomic patch editing.
Building and Deploying AI Applications
Quickly build various open-source chat clients or web applications with MoleAPI.