CCode - Claude Code Learning

An enhanced agentic coding tool that lives in your terminal. Understand your codebase, execute tasks, and handle workflows through natural language commands.

English | 中文

✨ Features

• 🗂️ File Management - Read, edit, create, and search files
• 🔍 Code Analysis - Explain architecture and complex logic
• ⚡ Command Execution - Run tests, lint, and other commands
• 🔄 Git Integration - Handle commits, PRs, and conflicts
• 🚀 Parallel Processing - SubAgent system for concurrent tasks
• 🛠️ Agent Management - Specialized agents for different tasks
• 🎣 System Hooks - Execute custom commands at key points

🚀 Quick Start

Prerequisites

• Node.js 18+
• npm or yarn
• Git
• Anthropic API Key

Installation

# Clone the repository
git clone https://github.com/BenBenVibe/ccode.git
cd ccode

# Install dependencies
npm install

# Build the project
npm run build

# Install globally (recommended)
npm install -g .

Setup & Usage

1. Set your API key:

   export ANTHROPIC_API_KEY="your-api-key-here"
   # Add to ~/.bashrc or ~/.zshrc for persistence

2. Start CCode:

   # If installed globally
   claude-local
   
   # Or run directly from source
   npm run start

3. Complete OAuth authentication when prompted

💡 Usage Examples

Basic Commands

# Code analysis and fixes
"Explain how the authentication system works"
"Fix the typescript errors in this file"
"Add unit tests for the login component"
"Refactor this function to be more readable"

# Git operations  
"Create a PR with my changes"
"Show me the git history for this file"
"Help me resolve this merge conflict"

# Project management
"Run tests and fix any failures"
"Update dependencies to latest versions"
"Generate documentation for this API"

Slash Commands

Command	Description
/help	Get help with using CCode
/compact	Compact conversation history
/agents	Manage SubAgent configurations
/bug	Report issues
/clear	Clear conversation history

Agent System

Use specialized agents for different tasks:

# Use specific agent types
"Use the code-analyzer agent to review this module"
"Have the performance-optimizer agent check this function"

# Manage agents
/agents  # Opens agent management interface

🔧 Development

Available Scripts

Command	Description
npm run start	Run the CLI application
npm run dev	Run in development mode
npm run build	Compile TypeScript to JavaScript
npm run lint	Run ESLint
npm test	Run test suite

Development Setup

# Fork and clone the repo
git clone https://github.com/yourusername/ccode.git
cd ccode

# Install dependencies
npm install

# Run in development mode
npm run dev

# Build for production
npm run build

# Install your local version globally
npm install -g .

Project Structure

├── src/
│   ├── components/          # React UI components
│   ├── tools/              # Tool implementations
│   ├── services/           # Core services
│   ├── utils/              # Utility functions
│   └── entrypoints/        # Application entry points
├── bin/                    # Executable scripts
├── .claude/               # Agent configurations
└── dist/                  # Compiled output

⚙️ Configuration

Project Configuration

Create a CLAUDE.md file in your project root:

# My Project

## Build Commands
- `npm run build` - Build the project
- `npm test` - Run tests

## Architecture
This project uses React with TypeScript...

## Code Style
- Use TypeScript strict mode
- Follow ESLint rules

System Hooks

Execute custom commands at key points:

# List hooks
claude hooks list

# Add a hook
claude hooks add PreToolUse "git add . && git commit -m 'Auto backup'" --matcher "FileWriteTool"

# Test hooks
claude hooks test SessionStart

🔧 Troubleshooting

Common Issues

1. API Key Issues

• Ensure ANTHROPIC_API_KEY is set correctly
• Check API key has sufficient credits
• Verify key is from Anthropic Console

2. Installation Issues

# Clean install
rm -rf node_modules package-lock.json
npm install
npm run build

3. Global Installation

# Reinstall globally
npm uninstall -g claude-code-local
npm install -g .

4. Permission Issues

# Make binary executable
chmod +x ./bin/claude-local

5. Working Directory Issues

• CCode should automatically detect your current directory
• If showing wrong directory, try reinstalling: npm install -g .

Getting Help

• Use /bug command within CCode to report issues
• Check GitHub Issues
• Create detailed bug reports with reproduction steps

🤝 Contributing

We welcome contributions! Here's how to get started:

Quick Contribution

1. Fork the repository
2. Create feature branch: git checkout -b feature/amazing-feature
3. Make changes and add tests
4. Commit: git commit -m 'Add amazing feature'
5. Push: git push origin feature/amazing-feature
6. Open a Pull Request

Development Guidelines

• Follow existing code patterns
• Add tests for new features
• Update documentation
• Run npm run lint before committing

See CONTRIBUTING.md for detailed guidelines.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Built on Anthropic's Claude
• Enhanced with SubAgent system and parallel processing
• Thanks to all contributors and the open source community

📊 Project Status

CCode is actively developed with these features:

• ✅ SubAgent system for parallel processing
• ✅ Enhanced dependency management
• ✅ Improved agent configurations
• ✅ Extended tool capabilities
• ✅ Working directory preservation
• 🚧 Continuous improvements and bug fixes

---

⭐ Star this repo if you find it helpful!

Issues • Contributing • Changelog