GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com β€” code2docs/code2docs/project at main Β· semcod/code2docs

Expand file tree

/

project

/
Copy path

Directory actions

More options

More options

Directory actions

More options

More options

Latest commit

 

History

History
History
/

project

/
Copy path

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
analysis.json
analysis.json
 
 
analysis.toon
analysis.toon
 
 
analysis.yaml
analysis.yaml
 
 
calls.mmd
calls.mmd
 
 
compact_flow.mmd
compact_flow.mmd
 
 
context.md
context.md
 
 
dashboard.html
dashboard.html
 
 
evolution.toon
evolution.toon
 
 
flow.mmd
flow.mmd
 
 
flow.toon
flow.toon
 
 
map.toon
map.toon
 
 
project.toon
project.toon
 
 
project.yaml
project.yaml
 
 
prompt.txt
prompt.txt
 
 

README.md

Outline

code2llm - Generated Analysis Files

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.

πŸ“ Generated Files Overview

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

🎯 Core Analysis Files

File Format Purpose Key Insights
analysis.toon TOON πŸ”₯ Health diagnostics - Complexity, god modules, coupling 27 critical functions, 0 god modules
evolution.toon TOON πŸ“‹ Refactoring queue - Prioritized improvements 0 refactoring actions needed
flow.toon TOON πŸ”„ Data flow analysis - Pipelines, contracts, types Data dependencies and side effects
map.toon TOON πŸ—ΊοΈ Structural map - Modules, imports, signatures Project architecture overview
project.toon TOON 🧠 Project logic - Compact module view from code2logic Generated via code2logic integration

πŸ€– LLM-Ready Documentation

File Format Purpose Use Case
prompt.txt Text πŸ“ Ready-to-send prompt - Lists all files with instructions Attach to LLM conversation as context guide
context.md Markdown πŸ“– LLM narrative - Architecture summary Paste into ChatGPT/Claude for code analysis
analysis.yaml YAML πŸ“Š Structured data - Machine-readable For scripts and automated processing
analysis.json JSON πŸ”§ API format - Programmatic access For integration with other tools

πŸ“Š Visualizations

File Format Purpose Description
flow.mmd Mermaid πŸ”„ Control flow diagram Function call paths with complexity styling
calls.mmd Mermaid πŸ“ž Call graph Function dependencies (edges only)
compact_flow.mmd Mermaid πŸ“¦ Module overview Aggregated module-level view

LLM-ready context only

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

Get refactoring recommendations

code2llm ./ -f evolution

Focus on specific code smells

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

Data flow analysis

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

evolution.toon - Refactoring Queue

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

flow.toon - Data Flow Analysis

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

map.toon - Structural Map

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

project.toon - Project Logic (Code2Logic)

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

prompt.txt - Ready-to-Send LLM Prompt

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

context.md - LLM Narrative

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)"

Get refactoring queue

code2llm ./ -f evolution cat evolution.toon

Focus on specific issues

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

Complexity Metrics (CC)

  • πŸ”΄ 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

Module Health

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

Data Flow Indicators

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

Analyze code quality in CI

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

Generate docs for README

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

Separate output directories

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

Split YAML into multiple files

code2llm ./ -f yaml --split-output

Separate orphaned functions

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
You are visitor 01402503 β€” GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800Γ—600. No cookies required.