rapids-ai
Version:
š RAPIDS - Portable Claude Code framework with 11 AI agents (including Material Design 3 expert), 5 MCPs, CI/CD automation, and revenue-first workflows. Token-optimized, ship fast, make money. Documentation: https://yanimeziani.github.io/rapids/
316 lines (237 loc) ā¢ 9.22 kB
Markdown
# š RAPIDS - Ship Fast, Make Money
**Portable, token-optimized Claude Code framework for velocity and revenue**
> Install once on any machine. Get 10 AI agents, 5 MCPs, CI/CD automation, and revenue-first workflows.
[](https://www.npmjs.com/package/rapids-ai)
[](https://opensource.org/licenses/MIT)
**RAPIDS** = Rapid AI-Powered Development & Shipping
**Philosophy**: Code without revenue is worthless. Ship fast, validate with users, iterate based on data.
## ā” Installation (One Command)
```bash
npm install -g rapids-ai
```
That's it! RAPIDS will automatically:
- Install 11 autonomous AI agents globally
- Configure 5 MCP servers (Context7, Filesystem, PostgreSQL, GitHub, Puppeteer)
- Set up CLI helpers (`rapids-init`, `rapids-update`)
- Display a beautiful installation progress UI
## šØ Beautiful Terminal UI
RAPIDS uses **Ink by Vadim Demedes** (the same framework powering Claude Code, GitHub Copilot, and Codex) for a stunning installation experience:
- š Rainbow gradient branding
- š Real-time progress bars
- āØ Animated spinners
- š BigText ASCII art
- š« Live MCP installation tracking
## š What You Get (Globally)
### 11 Autonomous Sub-Agents
AI agents that work in parallel (up to 3 simultaneously):
**Development Agents (10):**
- **Feature Builder** - Complete features across mobile/web/backend
- **Bug Hunter** - Find and fix bugs autonomously
- **Code Searcher** - Deep code analysis (auto-activated)
- **Test Generator** - Comprehensive test generation
- **Refactor Master** - Intelligent refactoring
- **Performance Analyzer** - Full-stack optimization
- **DB Architect** - Database schema management
- **Security Scanner** - Security audits
- **Deployment Manager** - Automated deployments
- **Design Master** - Material Design 3 expert for UNIQUE, brand-specific UIs (not generic templates)
**š° THE MOST CRITICAL AGENT:**
- **Marketing Strategist** - Revenue generation, user acquisition, GTM strategy, copywriting, pricing, growth hacking
### 5 MCP Servers (Cutting-Edge)
**Model Context Protocol** - The "USB-C for AI":
1. **Context7** š„ - Up-to-date documentation (auto-activated)
2. **Filesystem** - Local file access across all projects
3. **PostgreSQL** - Direct database querying
4. **GitHub** - Repository management, issues, PRs
5. **Puppeteer** - Web automation for market research
### Stack Templates
- Flutter + Riverpod mobile features
- Next.js 15 App Router pages
- FastAPI + SQLAlchemy endpoints
### Docker-First (Always Included)
- Dockerfiles for Next.js and FastAPI
- docker-compose.yml templates
- Multi-stage builds optimized for DokPloy
## š¦ Usage
### Migrate Existing Project (Non-Destructive)
```bash
cd your-existing-project
rapids-migrate
```
**Zero risk** - Analyzes and adds RAPIDS without touching your code:
- Auto-detects stack (Next.js, FastAPI, Flutter)
- Identifies project structure (monorepo, multi-folder, single)
- Creates `.claude/` configuration
- Initializes `.agent/` documentation system
- Preserves all existing files
[Read full migration guide ā](./docs/MIGRATION.md)
### Create New Project (Interactive)
```bash
rapids-init
```
Interactive wizard with:
- Project name input with validation
- Stack preset selection:
- š Full Stack (Mobile + Web + Backend)
- š± Mobile Only (Flutter)
- š Web + Backend
- ā” Backend Only (FastAPI)
- Automatic Dockerfile generation
- Beautiful success screen
### Update RAPIDS
```bash
rapids-update
```
Updates to the latest version while preserving your settings.
### Use in Claude Code
All 11 agents are globally available:
**Launch Design Agent:**
```
Launch design-master agent to:
- Create UNIQUE Material Design 3 color scheme with custom personality
- Design distinctive navigation with signature interactions
- Generate creative layouts that stand out while staying accessible
```
**Launch Marketing Agent:**
```
Launch marketing-strategist agent to:
- Create go-to-market strategy for my app
- Write landing page copy that converts
- Analyze competitors and recommend pricing
```
**Use MCP Servers:**
```
"use context7" to get latest Next.js 15 patterns
"use puppeteer" to scrape competitor pricing
```
**Launch Parallel Agents:**
```
Launch design-master + feature-builder + marketing-strategist in parallel to:
- Design UNIQUE, brand-specific UI (Material Design 3)
- Build the feature implementation
- Plan the feature launch campaign
```
## šÆ Optimized For
- **Flutter** mobile apps with Riverpod
- **Next.js 15** web applications
- **FastAPI** backends with async/await
- **PostgreSQL** databases
- **DokPloy** deployment
- **Making money** (Marketing & Business Strategy Agent)
## š Productivity Gains
- **Feature Development**: 3-5 days ā 4-8 hours (85% faster)
- **Bug Fixing**: 2-4 hours ā 15-30 minutes (90% faster)
- **Test Writing**: Manual ā Auto-generated
- **Deployment**: 30 minutes ā 5 minutes (83% faster)
- **Overall**: ~10x productivity multiplier
## šļø How It Works
RAPIDS installs globally to:
- **macOS**: `~/Library/Application Support/Claude/rapids/` ā `~/.claude/`
- **Linux**: `~/.config/claude/rapids/` ā `~/.claude/`
All your projects automatically have access to:
- 11 AI agents (including Material Design 3 expert)
- 5 MCP servers
- Stack templates
- Slash commands
## šØ Why RAPIDS?
**Before RAPIDS:**
```
ā Manually configure each project
ā Copy-paste agent configurations
ā Inconsistent setup across projects
ā No marketing/business strategy help
```
**After RAPIDS:**
```
ā
Install once, use everywhere
ā
All agents available globally
ā
Beautiful terminal experience
ā
Revenue-focused with marketing agent
```
## š Documentation
- [**RAPIDS Method**](./docs/RAPIDS_METHOD.md) - Complete methodology
- [**Development Guide**](./docs/DEVELOPMENT_GUIDE.md) - Usage guide
- [**Sub-Agents Guide**](./docs/SUBAGENTS_GUIDE.md) - Agent details
- [**Stack Config**](./.claude/STACK_CONFIG.json) - Stack requirements
## š§ Requirements
- **Node.js** 20+ (for Ink TUI)
- **Claude Code** (latest version)
- **macOS** or **Linux** (Windows support coming soon)
## š Tech Stack
- **Ink 5** - React for terminal UI
- **React 18** - Component framework
- **TypeScript** - Type safety
- **execa** - Shell command execution
- **fs-extra** - Enhanced file operations
## š¤ Contributing
Contributions welcome! Please read our contributing guidelines.
## š License
MIT License - Use freely in your projects.
## š Credits
Built for solo developers deploying on DokPloy with:
- **Anthropic Claude Code** - AI pair programming
- **Claude Sonnet 4.5** - Language model
- **Ink by Vadim Demedes** - Terminal UI framework
---
## š° Token Optimization (40-60% Savings)
RAPIDS achieves massive token savings through:
1. **Subagent Isolation** - Separate context windows per agent
2. **Parallel Execution** - Run 3 agents concurrently
3. **Smart Output Styles** - RAPIDS Speed & Ship Mode
4. **Auto-compact** - Trigger at 150K tokens
5. **Optimized Reads** - Using `offset`, `limit`, `head_limit`
**Example Savings:**
- Full-stack feature: 80-120K ā 35-50K tokens (~60% savings)
- Bug fix + test: 25-40K ā 10-18K tokens (~55% savings)
- Marketing campaign: 30-50K ā 15-25K tokens (~45% savings)
## šØ Output Styles (NEW!)
### RAPIDS Speed Mode
```bash
/output-style rapids-speed
```
- Extremely concise, action-first
- No preamble or explanations
- Target: <50K tokens per feature
### Ship Mode (Revenue-First)
```bash
/output-style ship-mode
```
- Every decision driven by revenue
- Validates ROI before building
- Focus on MRR, CAC, LTV, churn
## š CI/CD Automation (NEW!)
GitHub Actions templates included:
- `@claude fix this` on issues ā Auto-fix
- Open PR ā Auto-test + security scan
- Merge to main ā Auto-deploy
- Label `revenue` ā Marketing analysis
**Setup**: Add `ANTHROPIC_API_KEY` to GitHub Secrets, copy workflow file, done!
---
**Version**: 3.5.0 (Token-Optimized Release)
**Stack**: Flutter ā¢ Next.js 15 ā¢ FastAPI ā¢ PostgreSQL ā¢ Docker
**MCPs**: Context7 ā¢ Filesystem ā¢ PostgreSQL ā¢ GitHub ā¢ Puppeteer
**New**: Output Styles ā¢ CI/CD Templates ā¢ 60% Token Savings
š **Install once. Ship fast. Make money.** š
## š Full Documentation
- [Quick Start Guide](./docs/QUICK_START.md)
- [Token Optimization Guide](./docs/RAPIDS_OPTIMIZATION_GUIDE.md)
- [Installation Structure](./docs/INSTALLATION_STRUCTURE.md)
- [RAPIDS Method](./docs/RAPIDS_METHOD.md)
- [Development Guide](./docs/DEVELOPMENT_GUIDE.md)
- [Subagents Guide](./docs/SUBAGENTS_GUIDE.md)
- [Shortcuts](./docs/shortcuts.md)
- [Changelog](./docs/CHANGELOG.md)
## Quick Start
```bash
# Install globally (works on any machine with Claude Code)
npm install -g rapids-ai
# Run installer
rapids
# Activate revenue-first mode
/output-style ship-mode
# Build something that makes money
/agent marketing-strategist "Validate market for [idea]"
/agent feature-builder "Build [feature]"
/agent deployment-manager "Ship to production"
```
**Now go build something that makes money.** š°