diff --git a/README.md b/README.md index 26f5d6a..3f1f81d 100644 --- a/README.md +++ b/README.md @@ -1,425 +1,330 @@ # Claude Code Sidekick > Complete development framework for AI-assisted coding with Claude. -> Professional project scaffolding, specialized agents, and automation in one -> command. ![Claude Code Sidekick](public/social-card.png) --- -Test Flash Light - **© 2026 Dylan Burkey. All Rights Reserved.** -**PROPRIETARY SOFTWARE** - This software and all associated code, documentation, -and materials are the exclusive property of Dylan Burkey. Unauthorized copying, -modification, distribution, or use of this software is strictly prohibited. See -LICENSE file for complete terms. - --- -## Quick Start +## Table of Contents -### Option 1: CLI - Instant Project Creation (2 minutes) +- [How to Use Claude Code Sidekick](#how-to-use-claude-code-sidekick) + - [Starting a New Project](#starting-a-new-project) + - [Adding to an Existing Project](#adding-to-an-existing-project) + - [Using the Multi-Model AI Toolkit](#using-the-multi-model-ai-toolkit) +- [What's Included](#whats-included) +- [Common Workflows](#common-workflows) +- [Documentation](#documentation) +- [Examples](#examples) -```bash -npx create-claude-project -``` +--- -![Claude Code Sidekick](public/social-card-v3.png) +## How to Use Claude Code Sidekick -Follow the interactive prompts to scaffold a production-ready project with -Claude Code Sidekick configured. +### Starting a New Project -### Option 2: Manual Setup (5 minutes) +**Use this when:** You're starting a fresh project and want a production-ready +setup. -```bash -# Clone the repository -git clone https://github.com/dylanburkey/claude-code-sidekick.git -cd claude-code-sidekick - -# Copy to your project -cp -r .claude/ /your-project/ -cp PROJECT_STARTER.md /your-project/ +#### Option A: Interactive CLI (Recommended) -# Configure with Quick Start -# Edit PROJECT_STARTER.md, then run: -/quick-start +```bash +npx create-claude-project ``` ---- +The CLI will prompt you to: -## What is Claude Code Sidekick? +1. Choose a project name +2. Select a preset (Static, Astro, React, Next.js, Nuxt, SvelteKit, Full Stack) +3. Pick features (database, auth, analytics, etc.) -Traditional AI coding tools give you **suggestions**. Claude Code Sidekick gives -you **systems**. +**What you get:** -While Cursor, Windsurf, and Copilot excel at code completion and inline -suggestions, they leave you to figure out project structure, workflow -automation, and system integration. Claude Code Sidekick provides a complete, -opinionated development framework that transforms how you build software with -AI. +- Complete project scaffold with your chosen framework +- `.claude/` directory with agents, hooks, and rules +- Pre-configured integrations based on your selections +- Git initialized with initial commit +- Ready to run immediately -### Core Features - -- **Professional CLI** - `npx create-claude-project` for instant project - generation -- **50+ Specialized Agents** for every development task -- **35+ Pre-Configured MCP Integrations** (databases, cloud, analytics, - payments) -- **32+ Automated Hooks** for quality, testing, and deployment -- **Declarative Configuration** - Just flip TRUE/FALSE switches -- **Spec-Driven Development** with EARS notation -- **Complete Documentation** for every component - -**Setup Time:** 2 minutes with CLI, 5 minutes manual **Configuration:** Choose a -preset or use TRUE/FALSE flags **Result:** Production-ready development -environment - ---- - -## CLI Features - -![CLI Preview](public/social-card-v3.png) +```bash +# After scaffolding: +cd your-project +npm install +npm run dev +``` -The `create-claude-project` CLI scaffolds production-ready projects with: +#### Option B: Clone and Customize -- **8 Production Presets** - Static, Astro, React, Next.js, Nuxt, SvelteKit, - Full Stack, Custom -- **Feature Selection** - Database, auth, analytics, deployment configs -- **Automatic Setup** - All files, dependencies, and configurations -- **Claude Code Integration** - .claude/ directory with agents, hooks, and rules -- **Git Ready** - Initialized with .gitignore and initial commit -- **Zero Config** - Everything works out of the box +```bash +# Clone the starter files +git clone https://github.com/dylanburkey/claude-code-sidekick.git +cd claude-code-sidekick -[View CLI Documentation →](cli/README.md) +# Edit PROJECT_STARTER.md with your project details +# Then run the quick-start command in Claude Code: +/project-planner +``` --- -## Key Differentiators +### Adding to an Existing Project -### 1. Declarative Configuration +**Use this when:** You have an existing codebase and want to add Claude Code +Sidekick's features. -**Others:** Write complex configuration files, install tools manually, configure -each integration **Sidekick:** Mark what you want as TRUE, run one command, done +#### Step 1: Copy the .claude directory -```markdown -## MCP Configuration - -- **Neon Database**: `TRUE` -- **Cloudflare**: `TRUE` -- **GitHub**: `TRUE` -- **Stripe**: `TRUE` - -## Hooks Configuration - -- **Pre-Commit Validation**: `TRUE` -- **Auto Format on Save**: `TRUE` +```bash +# From the claude-code-sidekick repo, copy to your project: +cp -r .claude/ /path/to/your-project/ ``` -Run `/mcp-setup` and `/hooks-setup` - your entire development environment is -configured. - -### 2. Agent Library - -**Others:** General-purpose AI that tries to do everything **Sidekick:** 50+ -specialized agents, each expert in their domain - -- **Code Generation Agents** - Generate components, APIs, migrations, configs -- **Task Automation Agents** - Handle builds, deployments, CI/CD -- **Testing Agents** - Create tests, run audits, validate accessibility -- **Documentation Agents** - Generate docs, maintain READMEs, update changelogs -- **Blockchain Agents** - Smart contracts, DApps, Web3 integration +#### Step 2: (Optional) Copy helpful starter files -Each agent includes real examples, best practices, and MCP integration. - -### 3. MCP Integration at Scale - -**Others:** Manual MCP setup, one server at a time **Sidekick:** 35+ -pre-configured MCP providers across 10 categories +```bash +# Project planning template +cp PROJECT_STARTER.md /path/to/your-project/ -- **Databases**: Neon, Supabase, Turso, Pinecone -- **Cloud**: Cloudflare, AWS, Vercel, Railway -- **Development**: GitHub, GitLab, Linear, Sentry -- **Analytics**: GA4, PostHog, Axiom, Datadog -- **Payments**: Stripe, PayPal, Shopify -- **AI/ML**: OpenAI, Anthropic, Hugging Face, Replicate -- **And 20+ more...** +# Or use framework-specific starters: +cp PROJECT_STARTER_WORDPRESS.md /path/to/your-project/ +cp PROJECT_STARTER_SHOPIFY.md /path/to/your-project/ +``` -Each provider includes: +#### Step 3: Configure for your project -- JSON configuration -- Environment variable templates -- Setup documentation -- Agent integration examples +Open your project in Claude Code, then: -### 4. Automated Quality & Compliance +```bash +# Set up MCP integrations (databases, cloud, etc.) +/mcp-setup -**Others:** Manual testing, linting, and deployment **Sidekick:** 32+ hooks -automate your entire workflow +# Set up automation hooks +/hooks-setup -- **Git Hooks** - Validate commits, enforce standards, run tests -- **File Hooks** - Auto-format, sort imports, update docs -- **Build Hooks** - Pre-build validation, post-build analysis -- **Deployment Hooks** - Pre-deploy checks, rollback automation -- **Agent Hooks** - Task notifications, error handling +# Or run quick-start for guided setup +/quick-start +``` -All configurable with TRUE/FALSE flags. +#### What you can now do: -### 5. Spec-Driven Development +| Command | What it does | +| ------------------ | ----------------------------------------------- | +| `/project-planner` | Create a phased project plan | +| `/task-planner` | Break work into actionable tasks | +| `/mcp-setup` | Configure database, cloud, and API integrations | +| `/hooks-setup` | Set up automated quality checks | +| `/status` | Check project status and progress | -**Others:** Start coding, figure it out as you go **Sidekick:** Define -requirements first with EARS notation +--- -```markdown -## Functional Requirements +### Using the Multi-Model AI Toolkit -### Event-Driven +**Use this when:** You want to use multiple AI models (Claude, GPT-4, Gemini, +Venice) together. -- WHEN user clicks submit THE SYSTEM SHALL validate all fields -- WHEN validation passes THE SYSTEM SHALL send data to API +The multi-model toolkit lets you: -### State-Driven +- Run code reviews with consensus from multiple models +- Intelligently route tasks to the optimal model +- Search your codebase semantically -- WHILE form is submitting THE SYSTEM SHALL disable submit button -- WHILE user is authenticated THE SYSTEM SHALL show logout option +#### Setup -### Error Handling +```bash +cd tools/multi-model +pnpm install -- IF network request fails THEN THE SYSTEM SHALL retry up to 3 times +# Add API keys to .env (in project root) +OPENAI_API_KEY=sk-... +ANTHROPIC_API_KEY=sk-ant-... +GEMINI_API_KEY=... +VENICE_API_KEY=... # Optional: for Venice AI ``` -Clear, testable, unambiguous requirements that become your implementation -roadmap. - -### 6. Multi-Model AI Toolkit +**Note:** You only need ONE API key. The toolkit auto-detects what's available. -**Others:** Locked into a single AI provider **Sidekick:** Use Claude, GPT-4, -and Gemini together with intelligent routing +#### Code Review (Multiple Models) ```bash -# Consensus code review (multiple models must agree) -cd tools/multi-model +# Quick review (fast, cheap models) +pnpm review -- src/app.js --quick + +# Deep review (powerful models) pnpm review -- src/app.js --deep -# Semantic code search -pnpm index -- /path/to/project -pnpm search -- "authentication middleware" +# Review multiple files +pnpm review -- src/components/*.tsx ``` -**Built-in Multi-Model Tools:** +Issues are only reported if multiple models agree, reducing false positives. -| Tool | Purpose | Models Used | -| ------------- | ------------------------ | -------------------------- | -| `mm-review` | Consensus code review | GPT-4o + Claude + Gemini | -| `mm-index` | Codebase indexing | OpenAI Embeddings | -| `mm-search` | Semantic search | OpenAI Embeddings | -| `ModelRouter` | Intelligent task routing | Auto-selects optimal model | +#### Semantic Code Search -**Cross-Validation Benefits:** +```bash +# Index your codebase +pnpm index -- ./src -- Different models catch different issues -- Architecture decisions get multiple perspectives -- Security reviews are more thorough -- Cost optimization (use cheaper models for simple tasks) +# Search by meaning, not keywords +pnpm search -- "authentication logic" +pnpm search -- "error handling middleware" +``` -[View Multi-Model Toolkit →](tools/multi-model/README.md) +[Full Multi-Model Documentation →](tools/multi-model/README.md) --- -## Comparison - -### vs. Cursor - -**Cursor Strengths:** - -- Excellent AI pair programming -- Natural language code editing -- Context-aware suggestions - -**Sidekick Advantages:** - -- Complete project structure -- Pre-configured integrations (35+ MCPs) -- Automated workflows (32+ hooks) -- Specialized agents for every task -- Declarative configuration -- Reusable across all projects - -**Use Together:** Cursor for coding + Sidekick for structure and automation - -### vs. Windsurf +## What's Included -**Windsurf Strengths:** +``` +claude-code-sidekick/ +├── .claude/ # Core framework +│ ├── commands/ # Built-in commands (/project-planner, etc.) +│ ├── agents/ # 50+ specialized AI agents +│ ├── hooks/ # 32+ automation hooks +│ ├── mcp/ # 35+ pre-configured integrations +│ ├── rules/ # Code style, accessibility, docs standards +│ └── steering/ # Project guidance files +│ +├── cli/ # npx create-claude-project +│ +├── agent-library/ # Extended agent collection +│ ├── code-generation/ # Components, APIs, configs +│ ├── task-automation/ # Build, deploy, CI/CD +│ ├── testing/ # Tests, audits, validation +│ ├── documentation/ # Docs, READMEs, changelogs +│ └── blockchain/ # Smart contracts, Web3 +│ +├── tools/multi-model/ # Multi-model AI toolkit +│ +├── examples/ # Working example projects +│ ├── ssg-starter/ # Astro blog +│ └── crypto-dashboard/ # React + Web3 +│ +├── docs/ # Guides and documentation +│ +├── PROJECT_STARTER.md # Generic project template +├── PROJECT_STARTER_WORDPRESS.md +└── PROJECT_STARTER_SHOPIFY.md +``` -- Flow-based development -- Multi-file editing -- Contextual awareness +--- -**Sidekick Advantages:** +## Common Workflows -- Standardized workflows -- Pre-built agent library -- MCP integration system -- Quality automation -- Production-ready configurations -- Team collaboration features +### Workflow 1: Start a React/Next.js Project -**Use Together:** Windsurf for flow + Sidekick for structure and deployment +```bash +# 1. Create project +npx create-claude-project +# Select: Next.js preset, add database, add auth -### vs. Copilot +# 2. Start development +cd my-app +npm install +npm run dev -**Copilot Strengths:** +# 3. Use Claude Code commands +/project-planner # Plan your features +/task-planner # Break into tasks +``` -- Fast autocomplete -- Wide IDE support -- Simple setup +### Workflow 2: Add AI Code Review to CI/CD -**Sidekick Advantages:** +```bash +# 1. Set up multi-model toolkit +cd tools/multi-model +pnpm install -- Complete development framework -- Project structure and organization -- Integration management -- Quality enforcement -- Documentation automation -- Deployment pipelines +# 2. Add to pre-commit hook +cp examples/pre-commit-hook.js .git/hooks/pre-commit +chmod +x .git/hooks/pre-commit -**Use Together:** Copilot for suggestions + Sidekick for everything else +# 3. Code is now reviewed before each commit +``` ---- +### Workflow 3: Set Up Database + Auth for Existing Project -## What's Included +```bash +# 1. Copy .claude to your project +cp -r .claude/ /your-project/ -### Core Components +# 2. Run MCP setup in Claude Code +/mcp-setup -``` -.claude/ -├── commands/ # /project-planner, /task-planner, /mcp-setup, /hooks-setup, /quick-start -├── agents/ # Specialized AI agents for different tasks -├── hooks/ # 32+ automated development hooks -│ ├── definitions/ # Pre-configured hook definitions -│ ├── templates/ # Create custom hooks -│ └── examples/ # Example configurations -├── mcp/ # MCP integration system -│ ├── providers/ # 35+ pre-configured MCP providers -│ ├── templates/ # Custom MCP guide -│ └── configs/ # Generated configurations -├── rules/ # Development standards -│ ├── code-style.md -│ ├── accessibility.md -│ └── documentation.md -└── steering/ # Project-specific guidance - ├── product.md - ├── tech.md - └── structure.md +# 3. Select: Neon (database), Supabase (auth) +# 4. Add keys to .env +# 5. Done - integrations are configured ``` -### CLI Package +### Workflow 4: Build a Web3 DApp -``` -cli/ -├── bin/create-claude-project.js # CLI entry point -├── src/ -│ ├── index.js # Interactive prompts -│ ├── templates.js # 8 preset configurations -│ ├── scaffold.js # Project scaffolding -│ └── utils.js # Helper functions +```bash +# 1. Create with CLI +npx create-claude-project +# Select: React preset, add Web3 features + +# 2. Or use the example +cd examples/crypto-dashboard +npm install +npm run dev ``` -### Agent Library +### Workflow 5: Improve Code Quality on Legacy Project -``` -agent-library/ -├── code-generation/ # Generate components, APIs, configs -├── task-automation/ # Build, deploy, CI/CD automation -├── testing/ # Unit tests, E2E, accessibility audits -├── documentation/ # API docs, READMEs, changelogs -├── blockchain/ # Smart contracts, DApps, Web3 -└── templates/ # Create custom agents -``` +```bash +# 1. Add Claude Code Sidekick +cp -r .claude/ /legacy-project/ -### Multi-Model Toolkit +# 2. Set up hooks +/hooks-setup +# Enable: pre-commit validation, auto-format, lint -``` -tools/multi-model/ -├── bin/ -│ ├── review.js # mm-review CLI - consensus code review -│ ├── index-codebase.js # mm-index CLI - codebase indexing -│ └── search.js # mm-search CLI - semantic search -├── lib/ -│ ├── clients.js # Unified API for OpenAI, Anthropic, Gemini -│ ├── code-review.js # Multi-model consensus review system -│ ├── model-router.js # Intelligent task routing -│ └── embeddings.js # Codebase indexing & semantic search -├── examples/ -│ ├── pre-commit-hook.js # Git hook integration example -│ └── agent-integration.js # Claude Code workflow example -├── index.js # Main exports -├── package.json -└── README.md # Full documentation +# 3. Run multi-model review on critical files +cd tools/multi-model +pnpm review -- /legacy-project/src/critical-module.js --deep ``` -[View Multi-Model Documentation →](tools/multi-model/README.md) - --- ## Documentation ### Getting Started -- [CLI Guide](docs/guides/cli-guide.md) - Instant project creation with CLI -- [Quick Start Guide](docs/guides/quick-start-guide.md) - Preset-based setup -- [Getting Started](docs/guides/getting-started.md) - Complete setup reference -- [Beginner's Guide](docs/guides/beginner-guide.md) - For complete beginners - -### Comprehensive Guides +- [CLI Guide](docs/guides/cli-guide.md) - Using `npx create-claude-project` +- [Quick Start](docs/guides/quick-start-guide.md) - 5-minute setup +- [Beginner's Guide](docs/guides/beginner-guide.md) - Complete introduction -- [**Real-World SSG Example**](docs/guides/real-world-example-ssg.md) - Build a - production static site with blog, SEO, and modern CSS (with terminal - screenshots) -- [Nuxt Full-Stack Walkthrough](docs/guides/nuxt-fullstack-walkthrough.md) - - Build complete Nuxt app -- [Python FastAPI Walkthrough](docs/guides/python-fastapi-walkthrough.md) - - Build RESTful API -- [Web3 dApp with Privy](docs/guides/web3-dapp-privy-walkthrough.md) - Build - decentralized app -- [Troubleshooting](docs/guides/troubleshooting.md) - Solutions for 50+ common - issues +### Tutorials -### Systems Documentation +- [Build a Static Site (SSG)](docs/guides/real-world-example-ssg.md) - + Step-by-step with screenshots +- [Nuxt Full-Stack App](docs/guides/nuxt-fullstack-walkthrough.md) +- [Python FastAPI](docs/guides/python-fastapi-walkthrough.md) +- [Web3 DApp with Privy](docs/guides/web3-dapp-privy-walkthrough.md) -- [MCP Integration](agent-library/docs/mcp-integration.md) - MCP setup guide -- [Hooks Configuration](.claude/hooks/README.md) - Automation hooks -- [Agent Library](agent-library/README.md) - All available agents +### Multi-Model AI -### Multi-Model AI Tools +- [Multi-Model Toolkit](tools/multi-model/README.md) - Full documentation +- [Consensus Code Review](tools/multi-model/README.md#multi-model-code-review) +- [Semantic Search](tools/multi-model/README.md#semantic-code-search) -- [Multi-Model Toolkit Overview](tools/multi-model/README.md) - Full - documentation -- [Consensus Code Review](tools/multi-model/README.md#multi-model-code-review) - - Run code through multiple AI models -- [Intelligent Model Routing](tools/multi-model/README.md#intelligent-model-routing) - - Auto-select optimal model per task -- [Semantic Code Search](tools/multi-model/README.md#semantic-code-search) - - Index and search codebase by meaning -- [Pre-Commit Hook Example](tools/multi-model/examples/pre-commit-hook.js) - - CI/CD integration -- [Agent Integration Example](tools/multi-model/examples/agent-integration.js) - - Claude Code workflows - -### Advanced +### Reference -- [Creating Custom Agents](agent-library/templates/README.md) -- [Adding Custom MCPs](.claude/mcp/templates/custom-mcp-guide.md) -- [Building Custom Hooks](.claude/hooks/templates/custom-hook-guide.md) -- [EARS Requirements Notation](docs/ears-guide.md) +- [All Commands](.claude/commands/) +- [All Agents](agent-library/README.md) +- [All MCP Integrations](.claude/mcp/README.md) +- [All Hooks](.claude/hooks/README.md) +- [Troubleshooting](docs/guides/troubleshooting.md) -### Example Projects +--- -Working examples that demonstrate the full Sidekick workflow. +## Examples -#### SSG Starter (Astro Blog) +### SSG Starter (Astro Blog) ```bash cd examples/ssg-starter @@ -428,10 +333,9 @@ npm run dev # → http://localhost:4321 ``` -Static site with blog, SEO, JSON-LD, and modern CSS. -[View full guide →](examples/ssg-starter/README.md) +A production-ready static site with blog, SEO, and modern CSS. -#### Crypto Dashboard (React + Privy) +### Crypto Dashboard (React + Web3) ```bash cd examples/crypto-dashboard @@ -440,74 +344,59 @@ npm run dev # → http://localhost:5173 ``` -Web3 landing page with wallet auth, signature verification, and neon dashboard. -Runs in demo mode without a Privy key. -[View full guide →](examples/crypto-dashboard/README.md) - -### Reference - -- [All Available MCPs](.claude/mcp/README.md) -- [All Available Hooks](.claude/hooks/README.md) -- [Code Style Rules](.claude/rules/code-style.md) -- [Accessibility Standards](.claude/rules/accessibility.md) +Web3 landing page with wallet auth and signature verification. --- -## Use Cases - -### Startup MVP Development - -- Instant setup with CLI -- Integrated services (database, hosting, analytics, payments) -- Quality built-in (accessibility, security, performance) -- Fast iteration with automated testing and deployment - -### Enterprise Applications - -- Standardized workflows across all teams -- Compliance built-in (WCAG, security scanning) -- Integration with 35+ pre-configured services -- Automated documentation +## Why Claude Code Sidekick? -### Open Source Projects +| Feature | Cursor/Copilot | Claude Code Sidekick | +| --------------------------- | -------------- | --------------------------------- | +| Code completion | ✅ | Uses Claude Code | +| Project scaffolding | ❌ | ✅ Full CLI | +| Pre-configured integrations | ❌ | ✅ 35+ MCPs | +| Automated workflows | ❌ | ✅ 32+ hooks | +| Multi-model AI | ❌ | ✅ Claude + GPT + Gemini + Venice | +| Specialized agents | ❌ | ✅ 50+ agents | -- Instant contributor setup with CLI -- Contribution-ready (pre-commit hooks, standards enforcement) -- Auto-generated documentation -- Quality gates and automated testing - -### Blockchain Development - -- Quick DApp setup with CLI -- Specialized agents for smart contracts and DApp scaffolding -- Automated testing with testnet integration -- Built-in security scanning and auditing +**Use together:** Cursor/Copilot for inline suggestions + Sidekick for +structure, automation, and multi-model capabilities. --- -## Community & Support +## Quick Reference -### Contributing +### Essential Commands -We welcome contributions! Areas where you can help: +```bash +# In Claude Code: +/quick-start # Guided setup +/project-planner # Create project plan +/task-planner # Break into tasks +/mcp-setup # Configure integrations +/hooks-setup # Set up automation +/status # Check progress +``` -- **New Agents** - Add specialized agents to the library -- **MCP Providers** - Add new MCP integrations -- **Hooks** - Create useful automation hooks -- **CLI Presets** - Create new framework presets -- **Documentation** - Improve guides and examples -- **Examples** - Share real-world use cases +### Multi-Model CLI -See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. +```bash +# In tools/multi-model/: +pnpm review -- # Code review +pnpm index -- # Index codebase +pnpm search -- "query" # Semantic search +``` -### Getting Help +### Environment Variables -- **CLI Issues** - [CLI Documentation](cli/README.md) -- **General Issues** - - [GitHub Issues](https://github.com/dylanburkey/claude-code-sidekick/issues) -- **Discussions** - - [GitHub Discussions](https://github.com/dylanburkey/claude-code-sidekick/discussions) -- **Comprehensive Docs** - All guides in this repo +```bash +# .env +OPENAI_API_KEY=sk-... # For GPT models +ANTHROPIC_API_KEY=sk-ant-... # For Claude +GEMINI_API_KEY=... # For Gemini +VENICE_API_KEY=... # For Venice AI +USE_MULTI_MODEL=TRUE # Enable multi-model (default) +``` --- @@ -517,28 +406,10 @@ MIT License - See [LICENSE](LICENSE) for details. --- -## The Bottom Line - -**Other AI tools help you write code faster.** - -**Claude Code Sidekick helps you build software better.** - -- 2-minute setup with professional CLI -- 50+ specialized agents for every task -- 35+ pre-configured integrations -- 32+ automated quality checks -- Complete documentation for non-developers -- Production-ready from day one - -**Stop cobbling together tools. Start with a system.** +**Get started in 2 minutes:** ```bash npx create-claude-project ``` -![Claude Code Sidekick Overview](public/social-card-v2.png) - -[Get Started →](docs/guides/cli-guide.md) | -[Browse Agent Library →](agent-library/README.md) - -**Built for developers who want more than autocomplete.** +[Documentation](docs/) | [Examples](examples/) | [Agent Library](agent-library/) diff --git a/docs/QUICKSTART.md b/docs/QUICKSTART.md new file mode 100644 index 0000000..ab3397e --- /dev/null +++ b/docs/QUICKSTART.md @@ -0,0 +1,117 @@ +# Claude Code Sidekick - Quick Start + +Get up and running in under 5 minutes. + +--- + +## Choose Your Path + +### 🆕 Starting a New Project? + +```bash +npx create-claude-project +``` + +Follow the prompts. Done. + +--- + +### 📁 Have an Existing Project? + +```bash +# 1. Clone sidekick +git clone https://github.com/dylanburkey/claude-code-sidekick.git + +# 2. Copy the .claude folder to your project +cp -r claude-code-sidekick/.claude/ /path/to/your-project/ + +# 3. Open your project in Claude Code and run: +/quick-start +``` + +--- + +### 🤖 Just Want Multi-Model AI Tools? + +```bash +# 1. Clone and install +git clone https://github.com/dylanburkey/claude-code-sidekick.git +cd claude-code-sidekick/tools/multi-model +pnpm install + +# 2. Add at least one API key to .env +echo "ANTHROPIC_API_KEY=sk-ant-your-key" >> ../../.env + +# 3. Review code +pnpm review -- /path/to/your/file.js +``` + +--- + +## What Can I Do Now? + +### In Claude Code (with .claude/ set up): + +| Command | What it does | +| ------------------ | ------------------------------------- | +| `/quick-start` | Guided setup wizard | +| `/project-planner` | Create a phased project plan | +| `/task-planner` | Break features into tasks | +| `/mcp-setup` | Add database, cloud, API integrations | +| `/hooks-setup` | Add automated quality checks | +| `/status` | See project progress | + +### Multi-Model Tools: + +| Command | What it does | +| ------------------------ | -------------------------- | +| `pnpm review -- ` | AI code review (consensus) | +| `pnpm index -- ` | Index codebase for search | +| `pnpm search -- "query"` | Semantic code search | + +--- + +## Common First Steps + +### After creating a new project: + +```bash +cd your-project +npm install +npm run dev + +# Then in Claude Code: +/project-planner # Plan your features +``` + +### After adding to existing project: + +```bash +# In Claude Code: +/mcp-setup # Add integrations (database, auth, etc.) +/hooks-setup # Add quality automation +``` + +### For code review: + +```bash +cd tools/multi-model +pnpm review -- ../src/critical-file.js --deep +``` + +--- + +## Need More Help? + +- [Full README](../README.md) +- [CLI Documentation](guides/cli-guide.md) +- [Beginner's Guide](guides/beginner-guide.md) +- [Troubleshooting](guides/troubleshooting.md) + +--- + +## Minimum Requirements + +- Node.js 18+ +- Claude Code (Anthropic's CLI) +- At least one API key for multi-model tools (optional) diff --git a/docs/guides/getting-started.md b/docs/guides/getting-started.md index ccab16a..3c08691 100644 --- a/docs/guides/getting-started.md +++ b/docs/guides/getting-started.md @@ -1,205 +1,200 @@ -# Getting Started +# Getting Started with Claude Code Sidekick -Get your project running in 2 minutes with Quick Start presets, or take full -control with custom configuration. +This guide helps you pick the right path based on what you're trying to do. -## Choose Your Path - -### 🚀 Quick Start (Recommended for Most Projects) - -**Time:** 2 minutes | **Best for:** Standard tech stacks - -[Complete Quick Start Guide →](quick-start-guide.md) +--- -Select a preset that matches your project type and everything is configured -automatically. +## What Are You Trying To Do? -### ⚙️ Custom Configuration +### 🆕 "I'm starting a new project from scratch" -**Time:** 5-10 minutes | **Best for:** Unique requirements +**Use the CLI** - It's the fastest way to get a production-ready project. -Manually configure each aspect of your project for complete control. +```bash +npx create-claude-project +``` -### 📚 Full Walkthrough (For Beginners) +The CLI will: -**Time:** 30 minutes | **Best for:** First-time users +1. Ask you what kind of project (React, Next.js, Astro, etc.) +2. Ask what features you need (database, auth, payments, etc.) +3. Scaffold everything with Claude Code Sidekick pre-configured -[Complete Beginner's Guide →](beginner-guide.md) +**Time:** 2 minutes -Step-by-step walkthrough with explanations of every concept. +[→ Detailed CLI Guide](cli-guide.md) --- -## Quick Start Setup (2 Minutes) +### 📂 "I have an existing project and want to add Sidekick" -### Step 1: Copy Template Files +**Copy the .claude directory** to your project. ```bash -# Clone the repository +# Clone the repo git clone https://github.com/dylanburkey/claude-code-sidekick.git -cd claude-code-sidekick -# Copy to your project -cp -r .claude/ /path/to/your/project/ -cp PROJECT_STARTER.md /path/to/your/project/ -cp .env.example /path/to/your/project/ - -cd /path/to/your/project/ +# Copy .claude to your project +cp -r claude-code-sidekick/.claude/ /path/to/your-project/ ``` -### Step 2: Select Your Preset - -Open `PROJECT_STARTER.md` and choose your tech stack: - -```markdown -### Project Preset - -- [ ] **Static Website** - HTML, Modern CSS, Vanilla JS -- [x] **Astro Site** - Astro 5, Modern CSS, Islands ← Put X here -- [ ] **React App** - React, TypeScript, Vite -- [ ] **Next.js App** - Next.js 15, App Router -- [ ] **Vue/Nuxt** - Vue 3, Nuxt, Composition API -- [ ] **SvelteKit** - Svelte 5, SvelteKit -- [ ] **Full Stack** - Complete backend + frontend + database -- [ ] **Custom** - Manual configuration -``` - -### Step 3: Run Quick Start +Then open your project in Claude Code and run: ```bash /quick-start ``` -**Done!** Your project is configured with: +This will guide you through configuring Sidekick for your existing codebase. -- Code quality rules for your tech stack -- MCP servers (database, cloud, analytics) -- Development hooks (git, formatting, testing) -- Specialized AI agents -- Project structure +**Time:** 5 minutes -### Step 4: Add Your Project Details +--- -In `PROJECT_STARTER.md`, fill out: +### 🔍 "I just want the multi-model AI code review tools" -```markdown -## Project Information +You don't need the full framework - just the `tools/multi-model/` directory. -### Project Name +```bash +# Clone and set up +git clone https://github.com/dylanburkey/claude-code-sidekick.git +cd claude-code-sidekick/tools/multi-model +pnpm install -My Awesome App +# Add your API key(s) to .env in the repo root +echo "ANTHROPIC_API_KEY=sk-ant-your-key" >> ../../.env -### Project Description +# Review code +pnpm review -- /path/to/any/file.js +``` -A web application that helps users manage their tasks efficiently +[→ Multi-Model Toolkit Guide](../tools/multi-model/README.md) -### Primary Goal +**Time:** 3 minutes -Create a simple, beautiful task manager that works on all devices -``` +--- -### Step 5: Generate and Build +### 📖 "I'm new to all of this and need a full explanation" -```bash -# Create your project plan -/project-planner +Start with the Beginner's Guide, which explains every concept step by step. -# Generate implementation tasks -/task-planner +[→ Complete Beginner's Guide](beginner-guide.md) -# Let agents build your project -/task-runner -``` - -**Your application is ready!** +**Time:** 30 minutes (worth it if you're new) --- -## Custom Configuration (5-10 Minutes) +## Quick Overview: What Does Sidekick Include? -For projects with unique requirements: +| Component | What It Does | Location | +| --------------------- | -------------------------------------------- | -------------------- | +| **Commands** | Claude Code commands like `/project-planner` | `.claude/commands/` | +| **Agents** | 50+ specialized AI assistants | `.claude/agents/` | +| **Hooks** | 32+ automated quality checks | `.claude/hooks/` | +| **MCP Integrations** | 35+ pre-configured services | `.claude/mcp/` | +| **Multi-Model Tools** | Use Claude + GPT + Gemini together | `tools/multi-model/` | +| **Examples** | Working starter projects | `examples/` | -### Step 1: Copy Template Files +--- -Same as Quick Start Step 1 above. +## After Setup: What Commands Can I Use? -### Step 2: Select Custom Preset +Once you have `.claude/` in your project, these commands are available in Claude +Code: -```markdown -### Project Preset +| Command | What It Does | +| ------------------ | --------------------------------------------------- | +| `/quick-start` | Guided setup wizard | +| `/project-planner` | Create a phased project plan from your requirements | +| `/task-planner` | Break a feature into actionable tasks | +| `/task-runner` | Execute tasks with specialized agents | +| `/mcp-setup` | Configure external services (databases, APIs, etc.) | +| `/hooks-setup` | Set up automated quality checks | +| `/status` | Check project progress | +| `/analyze-project` | Analyze existing codebase | -- [x] **Custom** - Manual configuration -``` +--- -### Step 3: Configure Master Toggles +## Typical First-Day Workflow -```markdown -### Master Toggles +### For a new project: -- **MCP Servers**: `TRUE` # External services -- **Development Hooks**: `TRUE` # Automation -- **Code Quality Rules**: `TRUE` # Linting/standards -- **AI Agents**: `TRUE` # Specialized agents -``` +```bash +# 1. Create project +npx create-claude-project -**Set to `FALSE` to disable entire categories.** +# 2. Start dev server +cd my-project +npm install +npm run dev -### Step 4: Configure Code Rules +# 3. In Claude Code, plan your work +/project-planner +# → Creates phases with milestones + +# 4. Start building +/task-planner +# → Breaks first feature into tasks +``` -```markdown -## Code Rules Configuration +### For an existing project: -### Language Standards +```bash +# 1. Add Sidekick +cp -r claude-code-sidekick/.claude/ ./ -- **Modern JavaScript**: `TRUE` -- **TypeScript**: `FALSE` -- **Node.js**: `FALSE` -- **Python**: `FALSE` +# 2. Configure +/quick-start +# → Select your tech stack and features -### Framework Standards +# 3. Set up integrations +/mcp-setup +# → Select: database, auth, hosting, etc. -- **Astro**: `TRUE` -- **React**: `FALSE` (... configure what you need ...) +# 4. Set up automation +/hooks-setup +# → Enable: pre-commit checks, formatting, etc. ``` -See [Configuration Guide](configuration.md) for all options. +--- -### Step 5: Configure Services +## Common Questions -```markdown -## MCP Configuration +### "Do I need all the API keys?" -### Database & Storage +No. For the multi-model tools, you only need ONE of: -- **Neon Database**: `TRUE` -- **Supabase**: `FALSE` +- `ANTHROPIC_API_KEY` (Claude) +- `OPENAI_API_KEY` (GPT) +- `GEMINI_API_KEY` (Gemini) +- `VENICE_API_KEY` (Venice AI) -### Cloud & Infrastructure +The toolkit auto-detects what's available and works with whatever you have. -- **Cloudflare**: `TRUE` -- **Vercel**: `FALSE` (... select what you need ...) -``` +### "Can I use Sidekick with Cursor/Copilot?" -### Step 6: Apply Configuration +Yes! They complement each other: -```bash -/mcp-setup # Configure MCP servers -/hooks-setup # Configure development hooks -/rules-setup # Configure code quality rules -``` +- **Cursor/Copilot:** Inline code suggestions +- **Sidekick:** Project structure, automation, multi-model tools -### Step 7: Continue as Normal +### "What if I don't want all the features?" -Follow steps 4-5 from Quick Start above. +The `.claude/config.yml` lets you disable anything: -## What's Next? +```yaml +features: + mcp: false # Disable MCP integrations + hooks: false # Disable automation hooks + agents: false # Disable specialized agents +``` -- [Configure your project](configuration.md) -- [Learn about EARS notation](../architecture/index.md) -- [Explore the API](../api/index.md) +Or just delete the folders you don't need. + +--- -## Need Help? +## Next Steps -- Check the [Architecture docs](../architecture/index.md) for design decisions -- Review [CLAUDE.md](../../CLAUDE.md) for AI context -- Look at the [QUICKSTART.md](../../QUICKSTART.md) for more details +- [CLI Guide](cli-guide.md) - Full CLI documentation +- [Configuration Guide](configuration.md) - Customize everything +- [Troubleshooting](troubleshooting.md) - Common issues and fixes +- [Multi-Model Tools](../../tools/multi-model/README.md) - AI toolkit docs