CodeWave Documentation Index

November 8, 2025 · View on GitHub

Complete guide to all CodeWave documentation.

Getting Started

Start here if you're new to CodeWave:

README.md (714 lines)
- Overview and features
- Installation instructions
- Quick start guide
- 7-pillar methodology
- Agent profiles
- Output structure
- Performance metrics
- Contributing guidelines

Documentation by Topic

Quick References

QUICK_REFERENCE.md (473 lines)
- Fast lookup for common commands
- Scoring interpretation
- Output files guide
- Agent profiles summary
- Cost estimation
- Common workflows
- Keyboard shortcuts

Core Concepts

AGENTS.md (669 lines)
- Detailed agent specifications
- Agent interaction model
- Weights and scoring
- Conversation flows
- Integration patterns
- Common disagreements
- Round-by-round details
ARCHITECTURE.md (900+ lines)
- System overview and diagrams
- Technology stack
- Core components
- Data flow
- Multi-agent orchestration
- Developer Overview generation
- Convergence detection algorithm
- LLM integration
- RAG system
- Output generation
- State management
- Error handling

Usage Documentation

CLI.md (708 lines)
- Global options
- evaluate command reference
- batch-evaluate command reference
- config command reference
- Exit codes
- 10+ detailed examples
- Shell completion
- Tips and tricks
CONFIGURATION.md (687 lines)
- Quick start (2 minutes)
- Configuration methods
- All configuration options
- LLM provider setup (Anthropic, OpenAI, Google)
- Advanced configuration
- Environment variables
- Configuration file format
- Troubleshooting configuration issues
EXAMPLES.md (688 lines)
- Getting started tutorial
- Single commit evaluation
- Batch processing
- CI/CD integration (GitLab, GitHub, Jenkins)
- Data analysis scripts
- Team workflows
- Code examples (bash, Python, YAML)
HTML_REPORT_GUIDE.md (600+ lines)
- Understanding HTML reports
- 7-Pillar Summary cards
- Developer Overview
- Conversation Timeline
- Evaluation History
- Agent details interpretation
- Reading patterns and red flags
- Exporting and sharing
- Troubleshooting
ADVANCED_FEATURES.md (700+ lines)
- Developer Overview generation
- Convergence Detection algorithm
- Multi-Round Agent Discussion
- Understanding evaluation depth
- Advanced usage patterns
- Analyzing discussion quality

Developers

API.md (716 lines)
- Core classes (CodeWaveEvaluator)
- Agent interface
- Type definitions
- Services (LLM, Commit, VectorStore)
- Usage examples
- Error handling
- Configuration programmatically

Support

TROUBLESHOOTING.md (824 lines)
- Installation issues
- Configuration issues
- API & authentication
- Evaluation issues
- Performance issues
- Output issues
- Advanced debugging
- Quick fix checklist

Documentation Statistics

Document	Lines	Topic	Audience
README.md	750	Overview & Getting Started	Everyone
QUICK_REFERENCE.md	540	Fast Lookup	Users
HTML_REPORT_GUIDE.md	600	Report Interpretation	Users
ADVANCED_FEATURES.md	700	Deep Dive Features	Power Users
AGENTS.md	669	Agent Deep-Dive	Implementers
ARCHITECTURE.md	900	System Design	Developers
CLI.md	708	Command Reference	Users
CONFIGURATION.md	750	Setup Guide	Users
EXAMPLES.md	688	Practical Use Cases	Users
API.md	716	Programmatic Access	Developers
TROUBLESHOOTING.md	824	Support & Fixes	Everyone
TOTAL	8,245

I Want To...

Get started quickly → README.md - "Quick Start" section

Find a specific command → QUICK_REFERENCE.md - "Most Common Commands"

Understand the 7 pillars → README.md - "7-Pillar Evaluation Methodology"

Learn about agents → AGENTS.md - Full agent specifications

Integrate into CI/CD → EXAMPLES.md - "CI/CD Integration"

Configure for my setup → CONFIGURATION.md - All options

Fix an issue → TROUBLESHOOTING.md - Search by error

Use CodeWave programmatically → API.md - Complete API reference

Understand the architecture → ARCHITECTURE.md - System design

See practical examples → EXAMPLES.md - Real-world use cases

Understand my HTML report → HTML_REPORT_GUIDE.md - Complete report guide

Learn advanced features → ADVANCED_FEATURES.md - Deep dive into Developer Overview, Convergence, Multi-Round Discussion

Track model usage and costs → CONFIGURATION.md - Model Display and Cost Tracking sections

Command Cheat Sheet

Essential Commands

# Setup
codewave config              # Interactive configuration

# Evaluate
codewave evaluate HEAD       # Single commit
codewave batch-evaluate --count 50  # Multiple commits

# Manage Config
codewave config show         # View configuration
codewave config set model claude-3-5-sonnet-20241022  # Change setting

# Help
codewave --help              # General help
codewave evaluate --help     # Command help

START HERE
    │
    ├─→ [README.md] Overview & Installation
    │       │
    │       ├─→ [QUICK_REFERENCE.md] Fast Lookup
    │       ├─→ [QUICK_REFERENCE.md] Common Commands
    │       └─→ [CLI.md] Full Command Reference
    │
    ├─→ [CONFIGURATION.md] Setup Your Environment
    │       │
    │       └─→ [TROUBLESHOOTING.md] If Issues Occur
    │
    ├─→ [EXAMPLES.md] Practical Tutorials
    │       │
    │       ├─→ CI/CD Integration
    │       ├─→ Team Workflows
    │       └─→ Data Analysis
    │
    ├─→ [AGENTS.md] Understand Agent System
    │       │
    │       └─→ [ARCHITECTURE.md] Deep Technical Dive
    │
    └─→ [API.md] Programmatic Usage
            │
            └─→ [ARCHITECTURE.md] System Design

Feature Coverage

By Document

Feature	README	Quick Ref	CLI	Config	Examples	API	Agents	Architecture	Troubleshooting
Installation	✓								✓
Quick Start	✓
Commands	✓	✓	✓		✓
Configuration	✓	✓	✓	✓					✓
Agents	✓	✓					✓	✓
Architecture							✓	✓
CI/CD					✓
Examples			✓		✓	✓
Troubleshooting									✓
Scoring	✓	✓
Evaluation	✓	✓	✓		✓	✓	✓	✓	✓