|
| 1 | +# Getting Started |
| 2 | + |
| 3 | +Get up and running with Codingbuddy in minutes. |
| 4 | + |
| 5 | +## Prerequisites |
| 6 | + |
| 7 | +- **Node.js**: v18 or higher |
| 8 | +- **AI Tool**: Any supported AI coding assistant ([see full list](./supported-tools.md)) |
| 9 | + |
| 10 | +## Quick Start |
| 11 | + |
| 12 | +### Step 1: Initialize Your Project |
| 13 | + |
| 14 | +```bash |
| 15 | +# Set your Anthropic API key (required for project analysis) |
| 16 | +export ANTHROPIC_API_KEY=sk-ant-... |
| 17 | + |
| 18 | +# Initialize Codingbuddy in your project |
| 19 | +npx codingbuddy init |
| 20 | +``` |
| 21 | + |
| 22 | +This command analyzes your project and creates a `codingbuddy.config.js` file with: |
| 23 | + |
| 24 | +- Detected tech stack (languages, frameworks, tools) |
| 25 | +- Architecture patterns |
| 26 | +- Coding conventions |
| 27 | +- Testing strategy |
| 28 | + |
| 29 | +### Step 2: Configure Your AI Tool |
| 30 | + |
| 31 | +Add Codingbuddy to your AI assistant. Here's an example for Claude Desktop: |
| 32 | + |
| 33 | +**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json` |
| 34 | + |
| 35 | +```json |
| 36 | +{ |
| 37 | + "mcpServers": { |
| 38 | + "codingbuddy": { |
| 39 | + "command": "npx", |
| 40 | + "args": ["codingbuddy-mcp"] |
| 41 | + } |
| 42 | + } |
| 43 | +} |
| 44 | +``` |
| 45 | + |
| 46 | +For other AI tools, see [Supported Tools](./supported-tools.md). |
| 47 | + |
| 48 | +### Step 3: Start Coding |
| 49 | + |
| 50 | +Your AI assistant now has access to: |
| 51 | + |
| 52 | +- **Project context**: Tech stack, architecture, conventions |
| 53 | +- **Workflow modes**: PLAN → ACT → EVAL |
| 54 | +- **Specialist agents**: Security, performance, accessibility experts |
| 55 | + |
| 56 | +Try it: |
| 57 | + |
| 58 | +``` |
| 59 | +You: PLAN Create a user authentication feature |
| 60 | +
|
| 61 | +AI: # Mode: PLAN |
| 62 | + I'll design an authentication feature following your project's patterns... |
| 63 | +``` |
| 64 | + |
| 65 | +## Configuration |
| 66 | + |
| 67 | +### Generated Config File |
| 68 | + |
| 69 | +The `codingbuddy.config.js` file customizes AI behavior: |
| 70 | + |
| 71 | +```javascript |
| 72 | +module.exports = { |
| 73 | + // AI responds in this language |
| 74 | + language: 'en', |
| 75 | + |
| 76 | + // Project metadata |
| 77 | + projectName: 'my-app', |
| 78 | + |
| 79 | + // Technology stack |
| 80 | + techStack: { |
| 81 | + languages: ['TypeScript'], |
| 82 | + frontend: ['React', 'Next.js'], |
| 83 | + backend: ['Node.js'], |
| 84 | + }, |
| 85 | + |
| 86 | + // Architecture pattern |
| 87 | + architecture: { |
| 88 | + pattern: 'feature-sliced-design', |
| 89 | + }, |
| 90 | + |
| 91 | + // Coding conventions |
| 92 | + conventions: { |
| 93 | + naming: { |
| 94 | + files: 'kebab-case', |
| 95 | + components: 'PascalCase', |
| 96 | + }, |
| 97 | + }, |
| 98 | + |
| 99 | + // Testing approach |
| 100 | + testStrategy: { |
| 101 | + approach: 'tdd', |
| 102 | + coverage: 80, |
| 103 | + }, |
| 104 | +}; |
| 105 | +``` |
| 106 | + |
| 107 | +See [Configuration Schema](./config-schema.md) for all options. |
| 108 | + |
| 109 | +### Additional Context |
| 110 | + |
| 111 | +Add project-specific documentation that AI should know about: |
| 112 | + |
| 113 | +``` |
| 114 | +my-project/ |
| 115 | +├── codingbuddy.config.js |
| 116 | +└── .codingbuddy/ |
| 117 | + └── context/ |
| 118 | + ├── architecture.md # System architecture docs |
| 119 | + └── api-conventions.md # API design guidelines |
| 120 | +``` |
| 121 | + |
| 122 | +### Ignore Patterns |
| 123 | + |
| 124 | +Create `.codingignore` to exclude files from AI analysis: |
| 125 | + |
| 126 | +```gitignore |
| 127 | +# Dependencies |
| 128 | +node_modules/ |
| 129 | +
|
| 130 | +# Build output |
| 131 | +dist/ |
| 132 | +.next/ |
| 133 | +
|
| 134 | +# Sensitive files |
| 135 | +.env* |
| 136 | +*.pem |
| 137 | +``` |
| 138 | + |
| 139 | +## Using Workflow Modes |
| 140 | + |
| 141 | +### PLAN Mode (Default) |
| 142 | + |
| 143 | +Start with planning before making changes: |
| 144 | + |
| 145 | +``` |
| 146 | +You: PLAN Add dark mode support |
| 147 | +
|
| 148 | +AI: # Mode: PLAN |
| 149 | +
|
| 150 | + ## Implementation Plan |
| 151 | + 1. Create theme context... |
| 152 | + 2. Add toggle component... |
| 153 | + 3. Persist preference... |
| 154 | +``` |
| 155 | + |
| 156 | +### ACT Mode |
| 157 | + |
| 158 | +Execute the plan with code changes: |
| 159 | + |
| 160 | +``` |
| 161 | +You: ACT |
| 162 | +
|
| 163 | +AI: # Mode: ACT |
| 164 | +
|
| 165 | + Creating theme context... |
| 166 | + [Makes code changes following TDD] |
| 167 | +``` |
| 168 | + |
| 169 | +### EVAL Mode |
| 170 | + |
| 171 | +Review and improve implementation: |
| 172 | + |
| 173 | +``` |
| 174 | +You: EVAL |
| 175 | +
|
| 176 | +AI: # Mode: EVAL |
| 177 | +
|
| 178 | + ## Code Review |
| 179 | + - ✅ Theme context properly typed |
| 180 | + - ⚠️ Consider adding system preference detection |
| 181 | +``` |
| 182 | + |
| 183 | +## Using Specialist Agents |
| 184 | + |
| 185 | +Activate domain experts for specific tasks: |
| 186 | + |
| 187 | +``` |
| 188 | +You: Activate the security-specialist agent to review authentication |
| 189 | +
|
| 190 | +AI: [Activates security-specialist] |
| 191 | +
|
| 192 | + ## Security Review |
| 193 | + - Password hashing: ✅ Using bcrypt |
| 194 | + - Session management: ⚠️ Consider shorter token expiry |
| 195 | + ... |
| 196 | +``` |
| 197 | + |
| 198 | +Available specialists: |
| 199 | + |
| 200 | +- `security-specialist` - Security audits |
| 201 | +- `performance-specialist` - Optimization |
| 202 | +- `accessibility-specialist` - WCAG compliance |
| 203 | +- `code-reviewer` - Code quality |
| 204 | +- And [other specialists](../.ai-rules/agents/README.md) |
| 205 | + |
| 206 | +## Next Steps |
| 207 | + |
| 208 | +- [Supported Tools](./supported-tools.md) - Setup guides for each AI tool |
| 209 | +- [Philosophy](./philosophy.md) - Understanding the design principles |
| 210 | +- [API Reference](./api.md) - MCP server capabilities |
| 211 | +- [Development Guide](./development.md) - Contributing to Codingbuddy |
0 commit comments