🐙 Octopus CLI

The Modern Full-Stack Framework CLI for AI-First Development

Features

• 🚀 Instant Project Setup - Create production-ready projects in seconds
• 🧩 Modular Architecture - Add pre-built modules for auth, billing, teams, and more
• 🎯 Code Generation - Generate modules, entities, use cases, routers, and components
• 🗄️ Database Management - Start, migrate, and manage your database with Docker
• 🚢 One-Click Deploy - Deploy to Vercel, Cloudflare, Fly.io, or Railway
• 🩺 Health Checks - Diagnose issues with the doctor command

Installation

# Install globally
npm install -g @octopus/cli

# Or use via npx
npx @octopus/cli <command>

# Or with bun
bunx @octopus/cli <command>

Quick Start

# Create a new project
octopus new my-saas-app

# Navigate to project
cd my-saas-app

# Start database
octopus db start
octopus db push

# Start development
octopus dev

Commands

Project Commands

| Command | Description | |---------|-------------| | octopus new [name] | Create a new project | | octopus init | Initialize in current directory | | octopus dev | Start development server | | octopus build | Build for production |

Code Generation

| Command | Description | |---------|-------------| | octopus add <module> | Add pre-built module | | octopus generate module <name> | Generate feature module | | octopus generate entity <name> | Generate domain entity | | octopus generate usecase <name> | Generate use case | | octopus generate router <name> | Generate API router | | octopus generate component <name> | Generate React component | | octopus generate page <name> | Generate React page |

Database Management

| Command | Description | |---------|-------------| | octopus db start | Start PostgreSQL container | | octopus db stop | Stop database container | | octopus db push | Push schema changes (dev) | | octopus db generate | Generate migration | | octopus db migrate | Run migrations | | octopus db studio | Open Drizzle Studio | | octopus db seed | Run seed scripts | | octopus db reset | Reset database (⚠️) |

Deployment & Tools

| Command | Description | |---------|-------------| | octopus deploy [platform] | Deploy to cloud | | octopus doctor | Diagnose setup | | octopus upgrade | Upgrade packages |

Available Modules

Add pre-built modules to your project:

octopus add auth       # Email, OAuth, Magic Link
octopus add billing    # Stripe payments & subscriptions
octopus add teams      # Team/organization management
octopus add blog       # Blog with MDX support
octopus add notifications # Email, push, in-app
octopus add files      # S3/R2 file uploads
octopus add admin      # Admin dashboard
octopus add analytics  # Usage tracking

Project Templates

Default

Basic setup with authentication:

octopus new my-app --template default

SaaS Starter

Complete SaaS with billing, teams, and auth:

octopus new my-saas --template saas

Minimal

Bare minimum - just the core framework:

octopus new my-project --template minimal

Technology Stack

| Layer | Technology | |-------|-----------| | Runtime | Bun 1.2+ | | Backend | Hono | | API | oRPC + Zod | | Frontend | React 19 + Vite | | Database | Drizzle ORM + PostgreSQL | | Auth | Better-Auth | | DI | Awilix | | Monorepo | Turborepo |

Development

# Clone the repo
git clone https://github.com/octopus-framework/cli.git
cd cli

# Install dependencies
bun install

# Build
bun run build

# Run locally
bun run ./dist/index.js new test-project

License

MIT © Octopus Team