Skip to content

Deployment Guide

Quick Reference

  • Node.js: 18+ required
  • Install: npm install -g cody-master
  • Dashboard Port: 48120 (default)
  • Hosting: Cloudflare Pages (landing page)

Installation

Option 1: npm Global Install

bash
npm install -g cody-master

After installation, the following commands are available:

  • cody — primary CLI command
  • cm — short alias
  • codymaster — full name

Option 2: Clone & Build

bash
git clone https://github.com/omisocial/cody-master.git
cd cody-master
npm install
npm run build

Option 3: Install as AI Agent Skill

bash
# For Antigravity (Gemini)
cody install cm-tdd --platform gemini

# For Claude Code
cody install cm-tdd --platform claude

# For Cursor
cody install cm-tdd --platform cursor

Configuration

Project Initialization

bash
# Initialize a new Cody Master project
cm init

# This creates a .cm/ directory with:
# .cm/CONTINUITY.md     - Working memory
# .cm/config.yaml       - RARV settings
# .cm/memory/           - Learnings & decisions

Default Settings

SettingDefaultDescription
Dashboard Port48120HTTP server port
Data File~/.cody/cm-tasks.jsonProject & task storage
PID File~/.cody/cm-dashboard.pidDashboard process tracker
Stuck Threshold30 minutesTime before task flagged as stuck

Environment Configuration

bash
# Custom port
cm dashboard start --port 3001

# Custom project path
cm continuity init --path /my/project

Running the Dashboard

bash
# Start dashboard server
cm dashboard start

# Check status
cm dashboard status

# Open in browser
cm open

# Stop
cm dashboard stop

The dashboard will be available at http://codymaster.localhost:48120

Building from Source

Development

bash
# Install dependencies
npm install

# Run TypeScript compilation
npm run build

# Run tests
npm run test:gate

# Start landing page dev server
npx serve public -l 3000

Production Build

bash
# Full build pipeline
npm run build

# Output goes to dist/
# Landing page assets are in public/

Test Pipeline

bash
# Run all tests
npm run test:gate

# Run specific test file
npx vitest run test/frontend-safety.test.ts

Deployment to Cloudflare Pages

The landing page is deployed to Cloudflare Pages:

wrangler.toml Configuration

toml
name = "codymaster"
pages_build_output_dir = "./public"

Deploy Process

bash
# Deploy to production
npx wrangler pages deploy ./public --project-name=codymaster

# Deploy preview
npx wrangler pages deploy ./public --project-name=codymaster --branch=preview

DNS Setup

RecordNameValue
CNAMEcodymaster.pages.devCloudflare Pages auto-configured
CustomYour domainPoint to Cloudflare Pages

File Structure for Deployment

Production deployment:
├── public/                    # Cloudflare Pages
│   ├── index.html             # Landing page
│   ├── skills.html            # Skills catalog
│   ├── story.html             # Origin story
│   ├── demo.html              # Demo page
│   ├── start.html             # Getting started
│   ├── dashboard/             # Dashboard SPA
│   │   └── index.html
│   ├── css/                   # Stylesheets
│   ├── js/                    # Client-side JS
│   ├── i18n/                  # Translations
│   └── img/                   # Assets

npm Package:
├── dist/                      # Compiled TypeScript
│   ├── index.js               # CLI entry
│   ├── dashboard.js           # Dashboard server
│   └── ...
├── skills/                    # Skill definitions
└── package.json               # npm manifest

Monitoring

Dashboard Status

bash
# Check if dashboard is running
cm dashboard status

# View activity history
cm history --limit 20

# Check for stuck tasks
cm task stuck

Health Checks

The dashboard provides these endpoints for monitoring:

EndpointMethodPurpose
/api/tasks/stuckGETReturns tasks stuck > threshold
/api/judgeGETOverall task health evaluation
/api/activitiesGETRecent activity log
/api/deploymentsGETDeployment history

Open Source AI Agent Skills Framework