This directory contains the complete analysis of your project generated by code2llm. Each file serves a specific purpose for understanding, refactoring, and documenting your codebase.

When you run code2llm ./ -f all, the following files are created:

code2llm ./ -f context

# Fast analysis for large projects
code2llm ./ -f toon --strategy quick

# Memory-limited analysis
code2llm ./ -f all --max-memory 500

# Skip PNG generation (faster)
code2llm ./ -f all --no-png

code2llm ./ -f evolution

code2llm ./ -f toon --refactor --smell god_function

code2llm ./ -f flow --data-flow

### `analysis.toon` - Health Diagnostics
**Purpose**: Quick overview of code health issues
**Key sections**:
- **HEALTH**: Critical issues (🔴) and warnings (🟡)
- **REFACTOR**: Prioritized refactoring actions
- **COUPLING**: Module dependencies and potential cycles
- **LAYERS**: Package complexity metrics
- **FUNCTIONS**: High-complexity functions (CC ≥ 10)
- **CLASSES**: Complex classes needing attention

**Example usage**:
```bash
# View health issues
cat analysis.toon | head -30

# Check refactoring priorities
grep "REFACTOR" analysis.toon

Purpose: Step-by-step refactoring plan Key sections:

• NEXT: Immediate actions to take
• RISKS: Potential breaking changes
• METRICS-TARGET: Success criteria

Example usage:

# Track progress
grep "NEXT" evolution.toon

Purpose: Understand data movement through the system Key sections:

• PIPELINES: Data processing chains
• CONTRACTS: Function input/output contracts
• SIDE_EFFECTS: Functions with external impacts

Example usage:

# Find data pipelines
grep "PIPELINES" flow.toon

# Identify side effects
grep "SIDE_EFFECTS" flow.toon

Purpose: High-level architecture overview Key sections:

• MODULES: All modules with basic stats
• IMPORTS: Dependency relationships
• SIGNATURES: Public API functions

Example usage:

# See project structure
cat map.toon | head -50

# Find public APIs
grep "SIGNATURES" map.toon

Purpose: Compact module view generated by code2logic integration Key sections:

• Modules list: All project modules with file sizes
• Imports: Dependency information
• Classes/Functions: Summary counts

When to use: When you need a lightweight project overview combined with code2llm analysis

Example usage:

# View compact project structure
cat project.toon | head -30

# Find largest files
grep -E "^  .*[0-9]{3,}$" project.toon | sort -t',' -k2 -n -r | head -10

Purpose: Pre-formatted prompt listing all generated files for LLM conversation Contents:

• Files section: Lists all existing generated files with descriptions
• Missing section: Shows which files weren't generated (if any)
• Task section: Instructions for LLM analysis
• Requirements section: Guidelines for suggested changes

Example usage:

# Copy to clipboard and paste into ChatGPT/Claude
cat prompt.txt | pbcopy  # macOS
cat prompt.txt | xclip -sel clip  # Linux

Purpose: Ready-to-paste context for AI assistants Key sections:

• Overview: Project statistics
• Architecture: Module breakdown
• Entry Points: Public interfaces
• Patterns: Design patterns detected

Example usage:

# Copy to clipboard for LLM
cat context.md | pbcopy  # macOS
cat context.md | xclip -sel clip  # Linux

### Visualization Files (`*.mmd`, `*.png`)
**Purpose**: Visual understanding of code structure
**Files**:
- `flow.mmd` - Detailed control flow with complexity colors
- `calls.mmd` - Simple call graph
- `compact_flow.mmd` - High-level module view
- `*.png` - Pre-rendered images

**Example usage**:
```bash
# View diagrams
open flow.png  # macOS
xdg-open flow.png  # Linux

# Quick health check
code2llm ./ -f toon
cat analysis.toon | grep -E "(HEALTH|REFACTOR)"

code2llm ./ -f evolution cat evolution.toon

code2llm ./ -f toon --refactor --smell god_function

# Generate context for AI
code2llm ./ -f context
cat context.md

# Generate all docs for team
code2llm ./ -f all -o ./docs/

# Create visual diagrams
open docs/flow.png

• 🔴 Critical (≥5.0): Immediate refactoring needed
• 🟠 High (3.0-4.9): Consider refactoring
• 🟡 Medium (1.5-2.9): Monitor complexity
• 🟢 Low (0.1-1.4): Acceptable
• ⚪ Basic (0.0): Simple functions

• GOD Module: Too large (>500 lines, >20 methods)
• HUB: High fan-out (calls many modules)
• FAN-IN: High incoming dependencies
• CYCLES: Circular dependencies

• PIPELINE: Sequential data processing
• CONTRACT: Clear input/output specification
• SIDE_EFFECT: External state modification

code2llm ./ -f toon -o ./analysis if grep -q "🔴 GOD" ./analysis/analysis.toon; then echo "❌ God modules detected" exit 1 fi

# .git/hooks/pre-commit
code2llm ./ -f toon -o ./temp_analysis
if grep -q "🔴" ./temp_analysis/analysis.toon; then
    echo "⚠️  Critical issues found. Review before committing."
fi
rm -rf ./temp_analysis

code2llm ./ -f context -o ./docs/ echo "## Architecture" >> README.md cat docs/context.md >> README.md

## 📚 Next Steps

1. **Review `analysis.toon`** - Identify critical issues
2. **Check `evolution.toon`** - Plan refactoring priorities
3. **Use `context.md`** - Get LLM assistance for complex changes
4. **Reference visualizations** - Understand system architecture
5. **Track progress** - Re-run analysis after changes

# Deep analysis with all insights
code2llm ./ -m hybrid -f all --max-depth 15 -v

# Performance-optimized
code2llm ./ -m static -f toon --strategy quick

# Refactoring-focused
code2llm ./ -f toon,evolution --refactor

code2llm ./ -f all -o ./analysis-$(date +%Y%m%d)

code2llm ./ -f yaml --split-output

code2llm ./ -f yaml --separate-orphans

---

**Generated by**: `code2llm ./ -f all --readme`  
**Analysis Date**: 2026-03-09  
**Total Functions**: 255  
**Total Classes**: 56  
**Modules**: 40  

For more information about code2llm, visit: https://github.com/tom-sapletta/code2llm