### PLAN Mode Example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/getting-started.md

Starts with planning before making changes. The user requests a plan and AI responds with an implementation plan.

```text
You: PLAN Add dark mode support

AI: # Mode: PLAN

    ## Implementation Plan
    1. Create theme context...
    2. Add toggle component...
    3. Persist preference...
```

--------------------------------

### Example interaction with Codingbuddy

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/getting-started.md

An example of how to interact with your AI assistant after setup. The assistant responds with a PLAN mode message.

```text
You: PLAN Create a user authentication feature

AI: # Mode: PLAN
    I'll design an authentication feature following your project's patterns...
```

--------------------------------

### Project-level configuration example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-guide.md

Example codingbuddy.config.json for project-level settings: language, default mode, and enabled specialist agents.

```javascript
module.exports = {
  // Language for responses (auto-detected by default)
  language: 'en',  // 'en', 'ko', 'ja', 'zh', 'es'

  // Default workflow mode
  defaultMode: 'PLAN',

  // Enabled specialist agents
  specialists: [
    'security-specialist',
    'accessibility-specialist',
    'performance-specialist'
  ]
};
```

--------------------------------

### Setup commands for cloning, installing, testing, and starting the development server

Source: https://github.com/jeremydev87/codingbuddy/blob/master/CONTRIBUTING.md

Run these commands in order to clone the repository, install dependencies with Yarn, run tests, and start the development server. Requires Node.js v18+ and Yarn via Corepack.

```bash
# Clone the repository
git clone https://github.com/JeremyDev87/codingbuddy.git
cd codingbuddy

# Install dependencies
yarn install

# Run tests to verify setup
yarn workspace codingbuddy test

# Start development server
yarn workspace codingbuddy start:dev
```

--------------------------------

### Verify Installation

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/development.md

Run tests, build the project, and start in development mode for the codingbuddy workspace.

```bash
# Run tests
yarn workspace codingbuddy test

# Build the project
yarn workspace codingbuddy build

# Start in development mode
yarn workspace codingbuddy start:dev
```

--------------------------------

### Getting Started Commands

Source: https://github.com/jeremydev87/codingbuddy/blob/master/apps/landing-page/README.md

Commands to install dependencies, run the development server, build for production, run tests, and perform full validation (lint, format, typecheck, test, circular check).

```bash
# Install dependencies
yarn install

# Development server
yarn dev

# Production build
yarn build

# Run tests
yarn test

# Full validation (lint + format + typecheck + test + circular check)
yarn validate
```

--------------------------------

### Install Claude Code plugin for Codingbuddy

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/getting-started.md

Install the dedicated plugin for enhanced integration with Claude Code. Add the marketplace, install the plugin, and install the MCP server for full functionality.

```bash
# 1. Add the marketplace
claude marketplace add JeremyDev87/codingbuddy
```

```bash
# 2. Install the plugin
claude plugin install codingbuddy@jeremydev87
```

```bash
# 3. Install MCP server for full functionality
npm install -g codingbuddy
```

--------------------------------

### Install plugin via npm or yarn

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-guide.md

Global installation for more control over the plugin.

```bash
# Global installation
npm install -g codingbuddy-claude-plugin

# Or with yarn
yarn global add codingbuddy-claude-plugin
```

--------------------------------

### Quick Start Installation and Init

Source: https://github.com/jeremydev87/codingbuddy/blob/master/README.md

Commands to install codingbuddy globally and initialize it in your project. After running these, you add the MCP server configuration to your AI tool.

```bash
# 1. Install
npm install -g codingbuddy

# 2. Initialize your project
npx codingbuddy init

# 3. Add to your AI tool's MCP config
```

--------------------------------

### Vitest unit test example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/development.md

Basic Vitest test structure with beforeEach setup and example test cases for success and error scenarios.

```typescript
import { describe, it, expect, vi, beforeEach } from 'vitest';

describe('MyService', () => {
  let service: MyService;

  beforeEach(() => {
    service = new MyService();
  });

  it('should do something', () => {
    const result = service.doSomething();
    expect(result).toBe(expected);
  });

  it('should handle errors', () => {
    expect(() => service.doSomething()).toThrow('Error message');
  });
});
```

--------------------------------

### Install plugin via Claude Code Marketplace

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-guide.md

Add the marketplace and install the plugin. The URL format is deprecated; use the GitHub repository format shown.

```bash
# 1. Add the marketplace
claude marketplace add JeremyDev87/codingbuddy

# 2. Install the plugin
claude plugin install codingbuddy@jeremydev87
```

--------------------------------

### Keyword Examples for Modes

Source: https://github.com/jeremydev87/codingbuddy/blob/master/packages/claude-code-plugin/docs/migration-guide.md

Use these keywords at the start of a message to enter the corresponding mode. Keywords are not slash commands and require no namespace.

```text
PLAN design auth feature
ACT implement the login form
EVAL review the auth module
AUTO build user dashboard
```

--------------------------------

### Complete Configuration Example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/config-schema.md

A full configuration example showing all top-level fields: language, projectName, description, repository, techStack, architecture, conventions, testStrategy, ai, keyFiles, and avoid. This demonstrates a complete setup for a project, including the AI model and additional context.

```json
{
  "language": "ko",
  "projectName": "wishket-platform",
  "description": "Freelancer marketplace platform",
  "repository": "https://github.com/example/wishket-platform",
  "techStack": {
    "languages": ["TypeScript"],
    "frontend": ["React", "Next.js", "Tailwind CSS", "React Query"],
    "backend": ["NestJS", "TypeORM"],
    "database": ["PostgreSQL", "Redis"],
    "infrastructure": ["Docker", "AWS ECS", "GitHub Actions"]
  },
  "architecture": {
    "pattern": "feature-sliced",
    "structure": ["src/app", "src/features", "src/entities", "src/shared"],
    "componentStyle": "feature-based"
  },
  "conventions": {
    "style": "airbnb",
    "naming": {
      "files": "kebab-case",
      "components": "PascalCase",
      "functions": "camelCase"
    },
    "quotes": "single",
    "semicolons": true
  },
  "testStrategy": {
    "approach": "tdd",
    "frameworks": ["vitest", "playwright"],
    "coverage": 80,
    "unitTestPattern": "colocated",
    "mockingStrategy": "minimal"
  },
  "ai": {
    "defaultModel": "claude-sonnet-4-20250514"
  },
  "keyFiles": ["src/shared/types/index.ts", "docs/api.md"],
  "avoid": ["legacy-v1-api"]
}
```

--------------------------------

### Mode Keyword Usage Example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/AGENTS.md

Example of using the PLAN mode keyword to trigger the parse_mode tool, which loads the appropriate Agent and rules.

```text
PLAN Design a login feature
```

--------------------------------

### Install the plugin and MCP server

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-faq.md

Add the marketplace, install the plugin, and install the MCP server globally for full functionality.

```bash
# 1. Add the marketplace
claude marketplace add JeremyDev87/codingbuddy

# 2. Install the plugin
claude plugin install codingbuddy@jeremydev87

# 3. Install MCP server for full functionality
npm install -g codingbuddy
```

--------------------------------

### Verify codingbuddy installation

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-guide.md

Checks that codingbuddy is installed globally and displays its version.

```bash
which codingbuddy  # Should show path
codingbuddy --version
```

--------------------------------

### Full codingbuddy.config.json example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/customization.md

Complete configuration file with language, projectName, description, techStack, architecture, conventions, and testStrategy. Place in project root.

```json
{
  "language": "ko",
  "projectName": "my-awesome-app",
  "description": "A modern web application",
  "techStack": {
    "languages": ["TypeScript"],
    "frontend": ["React", "Next.js", "Tailwind CSS"],
    "backend": ["Node.js", "Prisma"],
    "database": ["PostgreSQL"],
    "tools": ["ESLint", "Prettier", "Vitest"]
  },
  "architecture": {
    "pattern": "feature-sliced-design",
    "structure": ["app", "widgets", "features", "entities", "shared"]
  },
  "conventions": {
    "style": "airbnb",
    "naming": {
      "files": "kebab-case",
      "components": "PascalCase",
      "functions": "camelCase"
    }
  },
  "testStrategy": {
    "approach": "tdd",
    "frameworks": ["Vitest", "Playwright"],
    "coverage": 80
  }
}
```

--------------------------------

### Correct and incorrect keyword placement for PLAN

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-troubleshooting.md

Shows the correct way to start a message with the PLAN keyword and an incorrect example where the keyword is not at the start.

```text
# Correct
PLAN implement user login

# Wrong - keyword not at start
Can you PLAN implement user login
```

--------------------------------

### Project Structure for Additional Context

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/getting-started.md

Shows the directory layout for adding project-specific documentation that AI should know about, including architecture.md and api-conventions.md.

```text
my-project/
├── codingbuddy.config.json
└── .codingbuddy/
    └── context/
        ├── architecture.md    # System architecture docs
        └── api-conventions.md # API design guidelines
```

--------------------------------

### Minimal codingbuddy.config.json example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/customization.md

A minimal configuration file with only language, projectName, and techStack.frontend.

```json
{
  "language": "ko",
  "projectName": "my-app",
  "techStack": {
    "frontend": ["React", "Next.js"]
  }
}
```

--------------------------------

### EVAL Mode Example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/getting-started.md

Reviews and improves implementation. The user says EVAL and AI provides a code review with suggestions.

```text
You: EVAL

AI: # Mode: EVAL

    ## Code Review
    - ✅ Theme context properly typed
    - ⚠️ Consider adding system preference detection
```

--------------------------------

### conventions configuration example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/customization.md

Defines naming and style conventions including file, component, function, and constant naming.

```json
{
  "conventions": {
    "style": "airbnb",
    "naming": {
      "files": "kebab-case",
      "components": "PascalCase",
      "functions": "camelCase",
      "constants": "SCREAMING_SNAKE_CASE"
    }
  }
}
```

--------------------------------

### prepare_parallel_agents Response Example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/api.md

Example response from prepare_parallel_agents with prepared agents and execution hint.

```json
{
  "content": [
    {
      "type": "text",
      "text": "{\"prepared\": [{\"agentName\": \"security-specialist\", \"systemPrompt\": \"...\", \"taskPrompt\": \"...\"}, ...], \"executionHint\": \"Use Task tool with subagent_type='general-purpose' and run_in_background=true\"}"
    }
  ]
}
```

--------------------------------

### recommend_skills Example Usage (TypeScript)

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/api.md

TypeScript examples showing how to call recommend_skills with prompts in English, Korean, and for building UI. Each call returns a recommended skill.

```typescript
// English
recommend_skills({ prompt: "There is a bug in the login" })
// => recommends: systematic-debugging

// Korean
recommend_skills({ prompt: "로그인에 버그가 있어" })
// => recommends: systematic-debugging

// Building UI
recommend_skills({ prompt: "Build a dashboard component" })
// => recommends: frontend-design
```

--------------------------------

### Verify versions match

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-guide.md

Displays the codingbuddy version; the plugin version is shown at startup in Claude Code.

```bash
codingbuddy --version
# Plugin version shown at startup in Claude Code
```

--------------------------------

### Full Featured Setup

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/tui-guide.md

Enables all features: Nerd Font icons, 24-bit color, debug logging, and stdio transport.

```bash
export MCP_TRANSPORT=stdio
export TERM_NERD_FONT=true
export COLORTERM=truecolor
export MCP_DEBUG=1
yarn workspace codingbuddy start:dev -- --tui
```

--------------------------------

### ACT Mode Example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/getting-started.md

Executes the plan with code changes. The user says ACT and AI makes code changes following TDD.

```text
You: ACT

AI: # Mode: ACT

    Creating theme context...
    [Makes code changes following TDD]
```

--------------------------------

### get_agent_system_prompt Response Example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/api.md

Example response from get_agent_system_prompt containing the system prompt and task prompt.

```json
{
  "content": [
    {
      "type": "text",
      "text": "{\"agentName\": \"security-specialist\", \"systemPrompt\": \"You are a Security Specialist agent...\", \"taskPrompt\": \"Analyze security of src/auth/login.ts...\"}"
    }
  ]
}
```

--------------------------------

### Fix npm permissions

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-guide.md

Sets up a local npm global directory and updates PATH to resolve EACCES or permission denied errors during installation.

```bash
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
export PATH=~/.npm-global/bin:$PATH
```

--------------------------------

### generate_checklist Request Example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/api.md

Example request for generate_checklist with files and domains.

```json
{
  "name": "generate_checklist",
  "arguments": {
    "files": ["src/auth/login.ts", "src/api/users.ts"],
    "domains": ["security", "testing"]
  }
}
```

--------------------------------

### recommend_skills Response Example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/api.md

Example response from recommend_skills, recommending the systematic-debugging skill with high confidence based on the matched pattern 'bug'.

```json
{
  "content": [
    {
      "type": "text",
      "text": "{\"recommendations\": [{\"skillName\": \"systematic-debugging\", \"confidence\": \"high\", \"matchedPatterns\": [\"bug\"], \"description\": \"Systematic approach to debugging\"}], \"originalPrompt\": \"There is a bug in the login\"}"
    }
  ]
}
```

--------------------------------

### Daily Development Commands

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/development.md

Commands for starting the development server with hot reload, linting, formatting, and type checking.

```bash
# Start development server with hot reload
yarn workspace codingbuddy start:dev

# Run linting
yarn workspace codingbuddy lint
yarn workspace codingbuddy lint:fix

# Run formatting
yarn workspace codingbuddy format:check
yarn workspace codingbuddy format

# Run type checking
yarn workspace codingbuddy typecheck
```

--------------------------------

### suggest_config_updates Response Example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/api.md

Example response from suggest_config_updates, showing a suggestion to update techStack.frontend from React to React and Next.js with high priority.

```json
{
  "content": [
    {
      "type": "text",
      "text": "{\"isUpToDate\": false, \"suggestions\": [{\"field\": \"techStack.frontend\", \"reason\": \"Detected new frontend framework(s)\", \"currentValue\": [\"React\"], \"suggestedValue\": [\"React\", \"Next.js\"], \"priority\": \"high\"}]}"
    }
  ]
}
```

--------------------------------

### Local development setup commands (Option 3)

Source: https://github.com/jeremydev87/codingbuddy/blob/master/apps/mcp-server/README.md

Build the MCP server locally from the apps/mcp-server directory. Run these commands in order: cd, yarn install, yarn build.

```bash
cd apps/mcp-server
yarn install
yarn build
```

--------------------------------

### prepare_parallel_agents Request Example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/api.md

Example request for prepare_parallel_agents with three specialists and a shared context.

```json
{
  "name": "prepare_parallel_agents",
  "arguments": {
    "mode": "EVAL",
    "specialists": ["security-specialist", "accessibility-specialist", "performance-specialist"],
    "targetFiles": ["src/components/UserForm.tsx"],
    "sharedContext": "Review the user registration form"
  }
}
```

--------------------------------

### techStack configuration example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/customization.md

Defines the project's technology stack with languages, frontend, backend, database, and tools arrays.

```json
{
  "techStack": {
    "languages": ["TypeScript", "Python"],
    "frontend": ["React", "Next.js"],
    "backend": ["FastAPI", "PostgreSQL"],
    "database": ["PostgreSQL", "Redis"],
    "tools": ["Docker", "GitHub Actions"]
  }
}
```

--------------------------------

### Initialize Codingbuddy in your project

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/getting-started.md

Run this command to initialize Codingbuddy in your project. It analyzes your project and creates a codingbuddy.config.json file with detected tech stack, architecture patterns, coding conventions, testing strategy, and default AI model selection. No API key is required.

```bash
# Initialize Codingbuddy in your project (no API key required)
npx codingbuddy init
```

--------------------------------

### list_skills Response Example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/api.md

Example response from list_skills, showing a list of skills with priorities and descriptions, and a total count.

```json
{
  "content": [
    {
      "type": "text",
      "text": "{\"skills\": [{\"name\": \"systematic-debugging\", \"priority\": 1, \"description\": \"Systematic approach to debugging\"}, {\"name\": \"test-driven-development\", \"priority\": 2, \"description\": \"TDD workflow\"}], \"total\": 10}"
    }
  ]
}
```

--------------------------------

### recommend_skills Request Example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/api.md

Example request payload for the recommend_skills tool, analyzing the prompt 'There is a bug in the login'.

```json
{
  "name": "recommend_skills",
  "arguments": {
    "prompt": "There is a bug in the login"
  }
}
```

--------------------------------

### Project Structure Tree

Source: https://github.com/jeremydev87/codingbuddy/blob/master/apps/landing-page/README.md

Directory tree showing the src/app structure with root layout, page, globals.css, locale layout, main page, and parallel routes for agents, code example, and quick start sections.

```text
src/app/
├── layout.tsx          # Root layout (fonts, theme, analytics)
├── page.tsx            # Root redirect → /en
├── globals.css         # Global styles
└── [locale]/
    ├── layout.tsx      # Locale layout (i18n, header, footer)
    ├── page.tsx        # Main page (Hero, Problem, Solution, FAQ)
    ├── @agents/        # Parallel route: Agents section
    ├── @code_example/  # Parallel route: Code example section
    └── @quick_start/   # Parallel route: Quick start section
```

--------------------------------

### Example: Python Developer Agent

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/customization.md

Example agent for a Python backend specialist. Includes expertise, responsibilities, workflow, and code quality settings.

```json
{
  "name": "Python Developer",
  "description": "Python backend specialist with FastAPI, Django, and data science expertise",

  "role": {
    "title": "Senior Python Developer",
    "expertise": [
      "Python 3.10+",
      "FastAPI / Django",
      "SQLAlchemy / Alembic",
      "pytest",
      "Type hints",
      "async/await patterns"
    ],
    "responsibilities": [
      "Develop REST APIs following best practices",
      "Write comprehensive tests with pytest",
      "Maintain type safety with mypy",
      "Follow PEP 8 style guide"
    ]
  },

  "context_files": [
    "packages/rules/.ai-rules/rules/core.md",
    "packages/rules/.ai-rules/rules/project.md"
  ],

  "workflow": {
    "api_development": "Design API → Write tests → Implement → Refactor",
    "data_models": "Define schemas → Create migrations → Add validation"
  },

  "code_quality": {
    "linting": "flake8, black, isort",
    "type_checking": "mypy strict mode",
    "testing": "pytest with 90%+ coverage"
  },

  "communication": {
    "language": "Korean (한국어)"
  }
}
```

--------------------------------

### codingbuddy.config.json Example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/apps/mcp-server/README.md

The `codingbuddy init` command creates a `codingbuddy.config.json` file. This example shows the configuration structure with language, project metadata, tech stack, architecture, conventions, and test strategy.

```javascript
module.exports = {
  // Response language (ko, en, ja, etc.)
  language: 'ko',

  // Project metadata
  projectName: 'my-awesome-app',
  description: 'A modern web application',

  // Technology stack
  techStack: {
    languages: ['TypeScript'],
    frontend: ['React', 'Next.js', 'Tailwind CSS'],
    backend: ['Node.js', 'Prisma'],
    database: ['PostgreSQL'],
    tools: ['ESLint', 'Prettier', 'Vitest'],
  },

  // Architecture pattern
  architecture: {
    pattern: 'feature-sliced-design',
    structure: ['app', 'widgets', 'features', 'entities', 'shared'],
  },

  // Coding conventions
  conventions: {
    style: 'airbnb',
    naming: {
      files: 'kebab-case',
      components: 'PascalCase',
      functions: 'camelCase',
    },
  },

  // Testing strategy
  testStrategy: {
    approach: 'tdd',
    frameworks: ['Vitest', 'Playwright'],
    coverage: 80,
  },
};
```

--------------------------------

### suggest_config_updates Request Example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/api.md

Example request payload for the suggest_config_updates tool, specifying the project root path.

```json
{
  "name": "suggest_config_updates",
  "arguments": {
    "projectRoot": "/path/to/project"
  }
}
```

--------------------------------

### generate_checklist Response Example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/api.md

Example response from generate_checklist with checklists and detected patterns.

```json
{
  "content": [
    {
      "type": "text",
      "text": "{\"checklists\": [{\"domain\": \"security\", \"items\": [{\"id\": \"sec-1\", \"description\": \"Validate input data\", \"priority\": \"high\"}]}], \"detectedPatterns\": [\"auth\", \"api\"]}"
    }
  ]
}
```

--------------------------------

### testStrategy configuration example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/customization.md

Defines the testing approach with TDD, frameworks, and coverage percentage.

```json
{
  "testStrategy": {
    "approach": "tdd",
    "frameworks": ["Vitest", "Playwright"],
    "coverage": 80
  }
}
```

--------------------------------

### Building Commands

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/development.md

Commands for production build and running the production build.

```bash
# Production build
yarn workspace codingbuddy build

# Run production build
node apps/mcp-server/dist/src/main.js
```

--------------------------------

### Example: Mobile Developer Agent

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/customization.md

Example agent for a React Native specialist. Includes expertise, responsibilities, and workflow for mobile development.

```json
{
  "name": "Mobile Developer",
  "description": "React Native specialist with cross-platform expertise",

  "role": {
    "title": "Senior Mobile Developer",
    "expertise": [
      "React Native",
      "Expo",
      "TypeScript",
      "Native Modules",
      "App Store / Play Store deployment"
    ],
    "responsibilities": [
      "Build cross-platform mobile apps",
      "Optimize performance for mobile",
      "Handle platform-specific features",
      "Manage app store releases"
    ]
  },

  "context_files": [
    "packages/rules/.ai-rules/rules/core.md"
  ],

  "workflow": {
    "features": "Design → Test → Implement → Test on devices",
    "performance": "Profile → Identify bottlenecks → Optimize"
  },

  "communication": {
    "language": "Korean (한국어)"
  }
}
```

--------------------------------

### list_skills Request Example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/api.md

Example request payload for the list_skills tool with empty arguments, returning all skills.

```json
{
  "name": "list_skills",
  "arguments": {}
}
```

--------------------------------

### Environment Variable Examples

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/tui-guide.md

Shows how to set environment variables for the TUI: enabling Nerd Font icons, disabling colors, enabling 24-bit color, and running SSE mode on a custom port.

```bash
# Enable Nerd Font icons
export TERM_NERD_FONT=true
yarn workspace codingbuddy start:dev -- --tui

# Disable colors (useful for CI/CD)
export NO_COLOR=1
yarn workspace codingbuddy start:dev -- --tui

# Enable 24-bit color support
export COLORTERM=truecolor
yarn workspace codingbuddy start:dev -- --tui

# SSE mode with TUI on custom port
export MCP_TRANSPORT=sse
export PORT=4000
yarn workspace codingbuddy start:dev -- --tui
```

--------------------------------

### Run build

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plans/2026-03-11-wsa-migration.md

Builds the landing-page app and shows the last 20 lines of output. Expected to succeed.

```bash
cd apps/landing-page && yarn build 2>&1 | tail -20
```

--------------------------------

### Check npm registry and verbose logging

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-troubleshooting.md

Verify the npm registry URL and enable verbose logging to diagnose network errors during installation.

```bash
# Check npm registry
npm config get registry
# Should be https://registry.npmjs.org/

# Try with verbose logging
npm install -g codingbuddy-claude-plugin --verbose
```

--------------------------------

### PLAN examples: specific vs less effective

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-examples.md

Shows a specific PLAN command versus a less effective one. The specific version includes details like pagination size.

```text
# Good
PLAN implement pagination for user list with 20 items per page

# Less effective
PLAN add pagination
```

--------------------------------

### PLAN and EVAL with focus

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-examples.md

Examples of using PLAN and EVAL with specific domain focus for deeper reviews.

```text
PLAN security review the payment processing module
EVAL with focus on accessibility
```

--------------------------------

### Install dependencies for production

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/errors.md

Install dependencies and build for production.

```bash
yarn install
yarn workspace codingbuddy build
```

--------------------------------

### Check Claude Code version and update

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-guide.md

Displays the installed Claude Code version and updates it globally via npm if needed.

```bash
claude --version
# Update if needed
npm update -g @anthropic-ai/claude-code
```

--------------------------------

### codingbuddy.config.json configuration example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/README.md

Create this JSON file in your project root to configure CodingBuddy. The example sets language to 'en', verbosity to 'compact', and default model to 'claude-sonnet-4-20250514'. Available options for language and verbosity are listed in the table; ai.defaultModel accepts any Claude model ID.

```json
{
  "language": "en",
  "verbosity": "compact",
  "ai": {
    "defaultModel": "claude-sonnet-4-20250514"
  }
}
```

--------------------------------

### Example Warning Log JSON

Source: https://github.com/jeremydev87/codingbuddy/blob/master/apps/mcp-server/SECURITY.md

Example log output when a dangerous key is detected, including level, message, filePath, and dangerousPath.

```json
{
  "level": "warn",
  "message": "Dangerous key detected in TypeScript config",
  "filePath": "/path/to/tsconfig.json",
  "dangerousPath": "__proto__"
}
```

--------------------------------

### Use /checklist command

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-examples.md

Invoke the /checklist command with domain keywords to generate a checklist. The example requests security and accessibility checklists.

```text
You: /checklist security accessibility
```

--------------------------------

### AI-powered initialization with --ai flag

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/getting-started.md

Use the --ai flag for deeper project analysis and more tailored configurations. Requires setting the ANTHROPIC_API_KEY environment variable first.

```bash
# Set your Anthropic API key
export ANTHROPIC_API_KEY=sk-ant-...

# Run AI-powered initialization
npx codingbuddy init --ai
```

--------------------------------

### Manual Deployment with Vercel CLI

Source: https://github.com/jeremydev87/codingbuddy/blob/master/apps/landing-page/README.md

Commands to install the Vercel CLI, create a preview deployment, and create a production deployment from the apps/landing-page directory.

```bash
# Install Vercel CLI
npm i -g vercel

# Preview deployment
cd apps/landing-page
vercel

# Production deployment
vercel --prod
```

--------------------------------

### Verify Node.js and Claude Code environment

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-guide.md

Run these commands to confirm Node.js v18.0.0 or higher and that Claude Code CLI is installed and authenticated.

```bash
# Check Node.js version
node --version  # Should be v18.0.0 or higher

# Check Claude Code is installed
claude --version
```

--------------------------------

### Install dependencies

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/errors.md

Install project dependencies using Yarn.

```bash
yarn install
```

--------------------------------

### Restart Claude Code

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-guide.md

Exits and restarts Claude Code to apply changes.

```bash
# Exit and restart
claude
```

--------------------------------

### get_agent_system_prompt Request Example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/api.md

Example request for get_agent_system_prompt with agentName 'security-specialist' and mode EVAL.

```json
{
  "name": "get_agent_system_prompt",
  "arguments": {
    "agentName": "security-specialist",
    "context": {
      "mode": "EVAL",
      "targetFiles": ["src/auth/login.ts"],
      "taskDescription": "Review authentication security"
    }
  }
}
```

--------------------------------

### Global install command (Option 2)

Source: https://github.com/jeremydev87/codingbuddy/blob/master/apps/mcp-server/README.md

Install CodingBuddy globally with npm. Requires Node.js v18+.

```bash
npm install -g codingbuddy
```

--------------------------------

### codingbuddy.config.json configuration example

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-faq.md

Create this configuration file in your project root to set language, default mode, and enabled specialists.

```javascript
module.exports = {
  language: 'en',
  defaultMode: 'PLAN',
  specialists: [
    'security-specialist',
    'accessibility-specialist'
  ]
};
```

--------------------------------

### Test MCP Connection with Workflow Command

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-guide.md

Start Claude Code and type a workflow command like 'PLAN implement a user login feature' to test the MCP connection. If configured correctly, you'll see a mode indicator, agent activation message, and structured plan output.

```bash
claude

# In Claude Code, type:
PLAN implement a user login feature
```

--------------------------------

### Example log entry for path traversal attempt

Source: https://github.com/jeremydev87/codingbuddy/blob/master/apps/mcp-server/SECURITY.md

Example JSON log entry from tryReadFile when a path traversal attempt is detected, with silent failure.

```json
{
  "level": "warn",
  "message": "tryReadFile: Path traversal attempt (silent failure)",
  "code": "PATH_TRAVERSAL_DETECTED",
  "filePath": "/project/../etc/passwd",
  "message": "Path escapes allowed base directory \"/project/config\""
}
```

--------------------------------

### Update codingbuddy packages

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-guide.md

Updates both codingbuddy and codingbuddy-claude-plugin globally to fix version mismatch issues.

```bash
npm update -g codingbuddy codingbuddy-claude-plugin
```

--------------------------------

### Clone the Repository

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/development.md

Clone the codingbuddy repository and navigate into the project directory.

```bash
git clone https://github.com/JeremyDev87/codingbuddy.git
cd codingbuddy
```

--------------------------------

### Check MCP configuration

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-guide.md

Displays the Claude settings file to verify the mcpServers section exists.

```bash
cat ~/.claude/settings.json
# Verify mcpServers section exists
```

--------------------------------

### Install Nerd Font on Linux

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/tui-guide.md

Download and install a Nerd Font (JetBrains Mono example) on Linux. Creates the fonts directory, downloads the font archive, extracts it, copies the .ttf files, refreshes the font cache, and verifies the installation.

```bash
# Create fonts directory
mkdir -p ~/.local/share/fonts
cd ~/.local/share/fonts

# Download and install a Nerd Font (example: JetBrains Mono)
curl -fLo "JetBrainsMono.zip" \
  https://github.com/ryanoasis/nerd-fonts/releases/latest/download/JetBrainsMono.zip
unzip JetBrainsMono.zip -d JetBrainsMono
cp JetBrainsMono/*.ttf .
rm -rf JetBrainsMono JetBrainsMono.zip

# Refresh font cache
fc-cache -fv

# Verify installation
fc-list | grep -i "jetbrains"
```

--------------------------------

### Update plugin via Claude Code

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-guide.md

Use this command to update the codingbuddy plugin through Claude Code.

```bash
claude plugin update codingbuddy
```

--------------------------------

### Remove plugin via Claude Code

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-guide.md

Use this command to remove the codingbuddy plugin via Claude Code.

```bash
claude plugin remove codingbuddy
```

--------------------------------

### Reinstall codingbuddy plugin

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-guide.md

Uninstalls and reinstalls the codingbuddy plugin to resolve issues when 'claude plugin list' does not show it.

```bash
claude plugin uninstall codingbuddy@jeremydev87
claude plugin install codingbuddy@jeremydev87
```

--------------------------------

### Activate security-specialist agent

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/getting-started.md

Use this command to activate a domain expert for a specific task. The AI responds with a structured review, as shown in the example output.

```text
You: Activate the security-specialist agent to review authentication

AI: [Activates security-specialist]

    ## Security Review
    - Password hashing: ✅ Using bcrypt
    - Session management: ⚠️ Consider shorter token expiry
    ...
```

--------------------------------

### Remove MCP server via npm

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-guide.md

Use this command to uninstall the codingbuddy MCP server globally via npm.

```bash
npm uninstall -g codingbuddy
```

--------------------------------

### Verify MCP Tools with /mcp

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-guide.md

In Claude Code, run '/mcp' to check available CodingBuddy tools such as parse_mode, get_agent_details, generate_checklist, read_context, and update_context.

```text
/mcp
```

--------------------------------

### Check Plugin Registration with claude plugin list

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-guide.md

Verify the CodingBuddy plugin is registered by running 'claude plugin list'. You should see 'codingbuddy' in the list.

```bash
claude plugin list
```

--------------------------------

### Enable Nerd Font in TUI on Windows

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/tui-guide.md

Set the TERM_NERD_FONT environment variable to true and start the TUI with the development server. This enables Nerd Font icons in the TUI after configuring Windows Terminal to use the installed Nerd Font.

```powershell
$env:TERM_NERD_FONT = "true"
yarn workspace codingbuddy start:dev -- --tui
```

--------------------------------

### Initialize Configuration with codingbuddy init

Source: https://github.com/jeremydev87/codingbuddy/blob/master/apps/mcp-server/README.md

Run `npx codingbuddy init` to create a configuration file. Requires the ANTHROPIC_API_KEY environment variable. Options include `--format json` for JSON output, `--force` to overwrite existing config, a project path, and `--api-key` to pass the API key directly.

```bash
# Basic usage (requires ANTHROPIC_API_KEY env var)
npx codingbuddy init

# With options
npx codingbuddy init --format json        # Output as JSON instead of JS
npx codingbuddy init --force              # Overwrite existing config
npx codingbuddy init /path/to/project     # Specify project path
npx codingbuddy init --api-key sk-...     # Pass API key directly
```

--------------------------------

### Project File Structure

Source: https://github.com/jeremydev87/codingbuddy/blob/master/apps/mcp-server/README.md

Shows the directory layout created by `codingbuddy init`, including the main configuration file, an ignore file, and an optional context directory for additional documentation.

```text
my-project/
├── codingbuddy.config.json     # Main configuration
├── .codingignore             # Files to ignore (gitignore syntax)
└── .codingbuddy/             # Additional context (optional)
    └── context/
        ├── architecture.md   # Architecture documentation
        └── api-guide.md      # API usage guide
```

--------------------------------

### Install codingbuddy-claude-plugin

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/migration-v3.md

Optional installation for native skill invocation in Claude Code. The MCP server continues to work without it.

```bash
npm install codingbuddy-claude-plugin
```

--------------------------------

### Install Nerd Font on Windows via Chocolatey

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/tui-guide.md

Install the JetBrains Mono Nerd Font using Chocolatey on Windows. Alternatively, manual installation steps are provided: download from the Nerd Fonts site, extract .ttf files, and install for all users.

```powershell
# Using Chocolatey
choco install nerd-fonts-jetbrainsmono

# Or manual installation:
# 1. Download from https://www.nerdfonts.com/font-downloads
# 2. Extract .ttf files
# 3. Right-click → Install for all users
```

--------------------------------

### Example Usage in ACT Mode

Source: https://github.com/jeremydev87/codingbuddy/blob/master/apps/mcp-server/README.md

Shows how the AI calls get_code_conventions before implementing, and how to use the returned conventions for TypeScript, Prettier, and EditorConfig.

```typescript
// AI calls this tool before implementing
const conventions = await get_code_conventions();

// TypeScript conventions
if (conventions.typescript.strict) {
  // ✅ Use strict mode - no implicit any
}

// Prettier conventions
const quote = conventions.prettier.singleQuote ? "'" : '"';
const semi = conventions.prettier.semi ? ';' : '';

// EditorConfig conventions
const indent = ' '.repeat(conventions.editorconfig.indent_size || 2);
```

--------------------------------

### Install Nerd Font on macOS with Homebrew

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/tui-troubleshooting.md

Install JetBrains Mono Nerd Font via Homebrew cask to enable icon rendering in the TUI.

```bash
brew install --cask font-jetbrains-mono-nerd-font
```

--------------------------------

### Expected debug output showing TUI started on stderr

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/tui-troubleshooting.md

Expected output from the debug logging command, confirming the TUI Agent Monitor starts on stderr.

```text
[codingbuddy] TUI Agent Monitor started (stderr)
```

--------------------------------

### Quick Actions Menu

Source: https://github.com/jeremydev87/codingbuddy/blob/master/packages/claude-code-plugin/commands/buddy.md

Markdown list of available /codingbuddy commands for quick actions.

```markdown
## ⚡ Quick Actions

- `/codingbuddy:plan` — Start planning a new task
- `/codingbuddy:act` — Execute current plan
- `/codingbuddy:eval` — Evaluate recent implementation
- `/codingbuddy:auto` — Autonomous development cycle
- `/codingbuddy:checklist [domain]` — Generate quality checklist
- `/codingbuddy:buddy` — Show this status again
```

--------------------------------

### Diagnose MCP connection issues

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-troubleshooting.md

Check if codingbuddy CLI is installed and inspect MCP configuration.

```bash
# Check if codingbuddy CLI is installed
which codingbuddy
codingbuddy --version

# Check MCP configuration
cat ~/.claude/settings.json | grep -A5 codingbuddy
```

--------------------------------

### .codingignore File to Exclude Files

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/getting-started.md

Excludes dependencies, build output, and sensitive files from AI analysis.

```gitignore
# Dependencies
node_modules/

# Build output
dist/
.next/

# Sensitive files
.env*
*.pem
```

--------------------------------

### Check MCP server is running

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-troubleshooting.md

Run codingbuddy in a separate terminal to verify it starts without errors.

```bash
# In a separate terminal, run:
codingbuddy
# Should start without errors
```

--------------------------------

### Compare default rules with customizations

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/customization.md

Downloads new default rules and compares them with your customizations using diff.

```bash
# Download new defaults
npx codingbuddy init --force --output .ai-rules.new

# Compare with your customizations
diff -r .ai-rules .ai-rules.new
```

--------------------------------

### Reset context with PLAN command

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-faq.md

Start a new PLAN to reset the context document. PLAN mode automatically resets the context file.

```text
PLAN start fresh implementation
```

--------------------------------

### Install Nerd Font on macOS via Homebrew

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/tui-guide.md

Install a Nerd Font using Homebrew cask on macOS. Choose one of the listed fonts (JetBrains Mono, Fira Code, Meslo LG, Roboto Mono). Verify installation by checking the font files in the system font directories.

```bash
# Install a Nerd Font (choose one)
brew install --cask font-jetbrains-mono-nerd-font    # JetBrains Mono
brew install --cask font-fira-code-nerd-font         # Fira Code
brew install --cask font-meslo-lg-nerd-font          # Meslo LG
brew install --cask font-roboto-mono-nerd-font       # Roboto Mono

# Verify installation (quick check)
ls ~/Library/Fonts/*JetBrains* /Library/Fonts/*JetBrains* 2>/dev/null
```

--------------------------------

### Configure fewer specialists in codingbuddy.config.json

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-troubleshooting.md

JavaScript configuration example to reduce the number of specialist agents for better performance.

```javascript
module.exports = {
  specialists: ['security-specialist']  // Only essential ones
};
```

--------------------------------

### Verify MCP server works

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/migration-v3.md

Run npx codingbuddy mcp to verify the MCP server is functioning.

```bash
# Verify MCP server works
npx codingbuddy mcp
```

--------------------------------

### Manual publishing commands

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/development.md

Builds the workspace and publishes the rules package and MCP server package to npm.

```bash
# Build first
yarn workspace codingbuddy build

# Publish rules package
cd packages/rules && npm publish

# Publish MCP server
cd apps/mcp-server && npm publish
```

--------------------------------

### Backup customizations before upgrading

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/customization.md

Creates backups of the .ai-rules directory and codingbuddy.config.json before upgrading.

```bash
cp -r .ai-rules .ai-rules.backup
cp codingbuddy.config.json codingbuddy.config.json.backup
```

--------------------------------

### Check stdout protection with debug logging

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/tui-troubleshooting.md

Runs the TUI with debug logging enabled to confirm the TUI Agent Monitor starts on stderr. Expected output includes '[codingbuddy] TUI Agent Monitor started (stderr)'.

```bash
MCP_DEBUG=1 yarn workspace codingbuddy start:dev -- --tui 2>&1 | head -50
```

--------------------------------

### Enable Nerd Font in TUI as one-liner

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/tui-troubleshooting.md

Set TERM_NERD_FONT=true inline and start the TUI in a single command.

```bash
TERM_NERD_FONT=true yarn workspace codingbuddy start:dev -- --tui
```

--------------------------------

### Initialize project configuration with npx codingbuddy init

Source: https://github.com/jeremydev87/codingbuddy/blob/master/apps/mcp-server/README.md

Run this command to analyze your project and generate codingbuddy.config.json. It is AI-powered and creates the configuration file automatically.

```bash
npx codingbuddy init
```

--------------------------------

### MCP Server Configuration for codingbuddy

Source: https://github.com/jeremydev87/codingbuddy/blob/master/README.md

JSON configuration for adding codingbuddy as an MCP server to your AI tool. This is the third step of the Quick Start, after installing and initializing.

```json
{
  "mcpServers": {
    "codingbuddy": {
      "command": "npx",
      "args": ["codingbuddy", "mcp"]
    }
  }
}
```

--------------------------------

### Check Claude Code version

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-troubleshooting.md

Verify the installed Claude Code version; the plugin system requires Claude Code 1.0+.

```bash
claude --version
# Plugin system requires Claude Code 1.0+
```

--------------------------------

### Quick Start Configuration (codingbuddy.config.json)

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/config-schema.md

Minimal configuration file for CodingBuddy. Sets language to Korean and defines project name and tech stack.

```json
{
  "language": "ko",
  "projectName": "my-awesome-app",
  "techStack": {
    "frontend": ["React", "TypeScript"],
    "backend": ["NestJS"]
  }
}
```

--------------------------------

### Generate configuration with npx codingbuddy init

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/errors.md

Run this command to generate a configuration file. Alternatively, create the file manually with touch.

```bash
# Generate configuration
npx codingbuddy init

# Or create manually
touch codingbuddy.config.json
```

--------------------------------

### Before: JavaScript config file (codingbuddy.config.js)

Source: https://github.com/jeremydev87/codingbuddy/blob/master/CHANGELOG.md

Shows the old JavaScript configuration format before v4.0.0. Use this as a reference when migrating to the new JSON-only format.

```javascript
module.exports = {
  language: 'en',
}
```

--------------------------------

### Update codingbuddy dependency

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/migration-v3.md

Update codingbuddy to the latest version using npm update or reinstall with npm install codingbuddy@latest.

```bash
# Update codingbuddy
npm update codingbuddy

# Or reinstall
npm install codingbuddy@latest
```

--------------------------------

### Force shutdown and reset

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/tui-troubleshooting.md

Find the process with ps aux, kill it with kill -9 (example PID 12345), then reset terminal.

```bash
# Find the process
ps aux | grep "yarn.*start:dev.*--tui"

# Kill the process (if PID is 12345)
kill -9 12345

# Reset terminal
reset
```

--------------------------------

### Fix npm permission errors (EACCES)

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/plugin-troubleshooting.md

Resolve EACCES errors during global npm install by using a Node version manager or fixing the npm prefix.

```bash
# Option A: Use a Node version manager
# Install nvm, then:
nvm install --lts
npm install -g codingbuddy-claude-plugin

# Option B: Fix npm prefix
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
npm install -g codingbuddy-claude-plugin
```

--------------------------------

### Run sync-version

Source: https://github.com/jeremydev87/codingbuddy/blob/master/docs/release-checklist.md

Syncs the plugin package.json and plugin.json versions. Run after bumping the primary source, version.ts, and rules package.

```bash
yarn workspace codingbuddy-claude-plugin sync-version
```