AI Factory Dashboard

Browser-based viewer for .ai-factory/ project directories. Visualizes plans, patches, evolutions, roadmap, and configuration in an interactive dashboard.

Quick Start

npx ai-factory-dashboard

Run this from any directory that contains a .ai-factory/ folder. The dashboard auto-detects the directory and opens at http://localhost:4173.

Installation

Install globally to use anywhere:

# npm
npm i -g ai-factory-dashboard

# pnpm
pnpm add -g ai-factory-dashboard

# bun
bun add -g ai-factory-dashboard

Then run from any project:

cd my-project
ai-factory-dashboard

Usage

ai-factory-dashboard [options]

Options

| Flag | Short | Default | Description | |------|-------|---------|-------------| | --port <port> | -p | 4173 | Server port | | --host <host> | -H | localhost | Server host | | --open | -o | false | Open browser on start | | --path <path> | | CWD/.ai-factory | Path to .ai-factory directory | | --version | -V | | Show version | | --help | -h | | Show help |

Examples

# Run in current directory
ai-factory-dashboard

# Custom port and auto-open browser
ai-factory-dashboard -p 3000 -o

# Point to a different project
ai-factory-dashboard --path /home/user/other-project/.ai-factory

# Expose to network
ai-factory-dashboard -H 0.0.0.0

Pages

| Page | Description | |------|-------------| | Dashboard | Project overview — description, tech stack, key metrics | | Plans | Implementation plans with task tracking and checkboxes | | Patches | Bug fixes and patches with root cause analysis | | Evolution | Architecture evolution entries and decision history | | Roadmap | Project milestones with progress tracking | | Config | View .ai-factory/ configuration files | | Settings | Configure the .ai-factory directory path |

Configuration

Path Priority

The dashboard resolves the .ai-factory/ path in this order:

1. Settings page override — saved via the Settings page in the UI
2. CLI flag — --path option
3. Auto-detected — $CWD/.ai-factory

Environment Variables

| Variable | Description | |----------|-------------| | AI_FACTORY_PATH | Override the default .ai-factory directory path |

Development

Clone the repo and install dependencies:

bun install
bun run dev

The dev server starts at http://localhost:3000 and reads from the local .ai-factory/ directory.

Scripts

| Command | Description | |---------|-------------| | bun run dev | Start dev server | | bun run build | Production build | | bun run preview | Preview production build | | bun run lint | ESLint | | bun run typecheck | TypeScript check |

How It Works

The dashboard is a Nuxt application that reads and parses files from your .ai-factory/ directory. When installed as an npm package, it ships a pre-built Nitro server (node-server preset) — no build step runs on your machine.

npx ai-factory-dashboard
  → bin/cli.mjs sets AI_FACTORY_PATH from your CWD
  → Starts the pre-built Nitro server (.output/server/index.mjs)
  → Server reads .ai-factory/ files and serves the dashboard UI
  → Browser opens at http://localhost:4173

License

MIT