User Guides

User Guides

How-to guides, tutorials, and documentation for all 20 CodeGraph analysis scenarios.

Overview

guides/
├── en/                      # English guides
│   ├── TUI_USER_GUIDE.md    # Complete TUI guide
│   ├── CLI_GUIDE.md         # CLI reference
│   ├── SCENARIOS.md         # All 20 scenarios
│   ├── PROGRAMMATIC_GUIDE.md # Python API
│   ├── CODE_REVIEW.md       # Code review system
│   ├── PROJECT_IMPORT.md    # Import projects
│   ├── TROUBLESHOOTING.md   # Common issues
│   └── scenarios/           # Scenario-specific guides
│       ├── 01-onboarding.md
│       ├── 02-security-audit.md
│       └── ...
└── ru/                      # Russian guides

User Guides

Guide Description
TUI User Guide Complete TUI guide with all 20 scenarios
Programmatic Guide Python API usage for automation
CLI Guide Complete CLI reference and usage
Quick Reference One-page cheat sheet

Feature Guides

Guide Description
Scenarios All 20 analysis scenarios with examples
Code Review Automated patch review
Project Import How to import projects
CPG Export Exporting Code Property Graphs
Monitoring System monitoring
Benchmark Guide Performance benchmarking
Refactoring Code refactoring patterns
Troubleshooting Common issues and solutions

20 Analysis Scenarios

Developer Scenarios

# Scenario Description
01 Onboarding New developer exploration
04 Feature Development Adding new features
05 Refactoring Code cleanup
15 Debugging Debugging assistance

Security Scenarios

# Scenario Description
02 Security Audit Vulnerability scanning
08 Compliance Regulatory compliance
14 Incident Response Security investigation
16 Entry Points API surface mapping

QA/Tester Scenarios

# Scenario Description
07 Test Coverage Coverage gap analysis
09 Code Review Automated code review

Technical Writer Scenarios

# Scenario Description
03 Documentation API documentation
11 Architecture Architecture docs

Advanced Scenarios

# Scenario Description
06 Performance Performance analysis
10 Cross-Repo Cross-repository analysis
12 Tech Debt Technical debt
13 Mass Refactoring Large-scale refactoring

Quick Start

  1. Install CodeGraph
  2. Configure environment
  3. Import your first project
  4. Run your first scenario