Documentation renewed! For old docs, visit doc.newapi.pro
New APINew API
User GuideInstallationAPI ReferenceAI ApplicationsHelp & SupportBusiness Cooperation

Factory Droid CLI

Project Introduction

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, build, debug, and refactor code, and even create complete applications.

Demo

droid.webp

Features

CategoryFeatureValue/CapabilityExample/Notes
Quick Start with CLI30-second installation; launch droid interactive session in project directory; supports macOS/Linux and WindowsRapid integration into current projects, no new tools requiredWindows Installation: irm https://app.factory.ai/cli/windows | iex; Launch: droid
End-to-End Feature DevelopmentFull-process automation from planning to implementation to testing; transparent review processAccelerate delivery, maintain human oversightNative diff viewing and approval process (see "Transparency and Control")
Deep Codebase UnderstandingIntegrates organizational shared knowledge from codebases, documentation, issue tracking; context-aware, improves over timeMore accurate suggestions and changesContinuously leverages knowledge across repositories and documents
Engineering System IntegrationNative integration with Jira, Notion, Slack, and other tools; development work stays synchronized with team processesReduce tool switching and information silos"etc." indicates more integrations
Production-Grade AutomationWorkflows reusable locally and in CI/CD; enterprise-grade security and compliance built-inConsistency and auditabilityAdapts to pipelines and enterprise environments
Enterprise CapabilitiesPrivate deployment options, SOC-2 compliance, air-gapped environmentsMeets security and compliance requirementsPrioritizes security and quality
Enhance Existing ToolsWorks in terminal, IDE, and existing development environments; no need to switch editors or learn new interfacesMaintain existing work habits, low migration costDeep integration with familiar tools
Transparency and ControlEvery decision is visible and reviewable; complete oversight of code changes; native diff viewing and approval workflowsReduce risk, enhance controllabilityAudit-friendly, traceable
Model FlexibilityNot locked to a single AI provider; choose the best model per task; consistent organizational behavior and memoryOptimal choice between performance and costSupports multi-model routing
Next Steps & ResourcesQuickstart, Common Use Cases, IDE Integration, Configuration, AGENTS.mdFacilitates adoption and practiceSee "Next steps/Additional resources" on the page

AI Model Configuration Method

Windows Graphical Guide

1. Open Terminal

windows_open_terminal

2. Install Factory Droid CLI

Official one-click installation command:

One-click Installation Command

irm https://app.factory.ai/cli/windows | iex

windows-install

3. Modify Configuration File

Droid CLI requires modifying the configuration file to use third-party APIs.

windows-configure.webp

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

Now you can start using Droid CLI!

Launch Droid CLI

Launch Droid CLI directly:

droid

Use in a specific project:

# Navigate to your project directory
cd C:\path\to\your\project

# Launch Droid CLI
droid

Press Enter to launch Droid CLI.

Droid CLI requires users to log in to an official account (free) before use.

5. Windows Common Issues Solution

Installation prompts "permission denied" error

This is usually a permission issue. Try the following solutions:

  • Run PowerShell as an administrator
  • Or configure npm to use the user directory: npm config set prefix %APPDATA%\npm

PowerShell Execution Policy Error

If you encounter an execution policy restriction, run:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

macOS/Linux Graphical Guide

1. Install Droid CLI

Install Droid CLI

Open your terminal and run the following command:

curl -fsSL https://app.factory.ai/cli | sh

macos-open-terminal

macos-img-02.webp

Follow the installation prompts to modify environment variables (copy the installation prompt code directly):

For Linux, choose ~/.bashrc or ~/.zshrc as appropriate.

Droid CLI Environment Variables (Example Only)

echo 'export PATH=/Users/modify_here/.local/bin:$PATH' >> ~/.zshrc
source ~/.zshrc

2. Modify Configuration File

Droid CLI requires modifying the configuration file to use third-party APIs.

One-click Configuration File Modification

curl -fsSL https://raw.githubusercontent.com/QuantumNous/new-api-docs/refs/heads/main/helper/factory-cli-setup.sh | bash

macos-img-03.webp

3. Start Using Droid CLI

Now you can start using Droid CLI!

Launch Droid CLI

Launch Droid CLI directly:

droid

Use in a specific project:

# Navigate to your project directory
cd /path/to/your/project

# Launch Droid CLI
droid

Press Enter to launch Droid CLI.

Droid CLI requires users to log in to an official account (free) before use.

How is this guide?

Last updated on