Droid Factory install

Install custom Factory Droid subagents and delegate work using custom slash commands with a single npx @droid-factory/install (or bunx @droid-factory/install) call. The installer defaults to copying all available commands and droids into your personal Factory workspace (~/.factory/{commands,droids}) and offers granular control when you need it.

Usage

npx @droid-factory/install

bunx @droid-factory/install

The interactive flow shows an install plan, highlights pre-existing files, and asks for confirmation before writing. Add --yes to skip the prompt or --dry-run to preview without writing.

Ensure Custom Droids are enabled in Factory (/settings → Experimental → Custom Droids) or by adding "enableCustomDroids": true to ~/.factory/settings.json; otherwise the installed commands cannot launch their helper agents.

Common variations

| Goal | Command | | --- | --- | | Install everything (explicit) | npx @droid-factory/install --commands all --droids all (or use bunx) | | Install only commands | npx @droid-factory/install --only-commands --commands all | | Install a single command | npx @droid-factory/install --only-commands --commands code-review | | Install only droids | npx @droid-factory/install --only-droids --droids all | | Install specific droids | npx @droid-factory/install --only-droids --droids security-code-reviewer,test-coverage-reviewer | | Target a project repo | npx @droid-factory/install --scope project --path /path/to/repo --commands all --droids all | | Generate PR readiness report | npx @droid-factory/install --only-commands --commands pr-ready | | Draft a focused test plan | npx @droid-factory/install --only-commands --commands test-plan | | Scan for TODO/FIXME markers | npx @droid-factory/install --only-commands --commands todo-scan | | Force overwrite existing files | add --force | | Disable spinner | add --no-spinner | | List templates | npx @droid-factory/install --list (or bunx) |

Contributing commands or droids

1. Fork this repository.
2. Add or modify Markdown templates in templates/commands/ or templates/droids/.
3. Run npm test or npm run lint if scripts are provided (future roadmap).
4. Verify your changes locally (see "Local development" below).
5. Commit with clear messages and open a pull request against the main branch.
6. Include before/after installer output as needed to demonstrate your change.

Local development

git clone https://github.com/iannuttall/droid-factory.git
cd droid-factory
npm install

node bin/droid-factory.js --dry-run --no-spinner --yes
node bin/droid-factory.js --yes

Use npm pack to sanity-check the tarball before publishing, and remember to bump package.json versions per semantic versioning guidelines.

Overview

flowchart TD
  A[Install @droid-factory/install] --> B[~/.factory/commands]
  A --> C[~/.factory/droids]

  subgraph Commands
    D[/code-review/]
    E[/release-notes/]
    F[/pr-ready/]
    G[/test-plan/]
    H[/todo-scan/]
  end

  B --> D & E & F & G & H
  C --> I[git-summarizer]
  C --> J[code-quality-reviewer]
  C --> K[security-code-reviewer]
  C --> L[performance-reviewer]
  C --> M[test-coverage-reviewer]
  C --> N[documentation-accuracy-reviewer]
  C --> O[release-notes-writer]
  C --> P[pr-readiness-reviewer]
  C --> Q[test-plan-writer]
  C --> R[todo-fixme-scanner]

  D --> I --> J & K & L & M & N
  E --> I --> O --> S{Save?}
  F --> I --> P --> T{Save?}
  G --> I --> U{Changes?}
  U -- No --> M --> Q
  U -- Yes --> Q
  H --> R