Documentation Index
Documentation Index
Section titled “Documentation Index”Welcome to the Arxo documentation. This page provides an organized overview of all available documentation.
Getting Started
Section titled “Getting Started”Essential guides for new users:
- Introduction - What is Arxo and why use it
- Installation - Install Arxo
- Quick Start - Your first analysis
- Configuration - Configure analysis options
Library Integration
Section titled “Library Integration”Use Arxo as a library in your applications
Integrate the closed-source arxo-engine into your own tools, CI systems, or custom workflows:
- Overview - Architecture and capabilities
- Getting Started - Installation and setup
- Rust API - Rust integration guide
- FFI API - C-compatible interface (coming soon)
- Node.js API - JavaScript/TypeScript bindings (coming soon)
- Python API - Python bindings (coming soon)
Note: Only public APIs and usage patterns are documented. The engine implementation is proprietary.
Guides
Section titled “Guides”Practical guides for common tasks:
Essential Guides
Section titled “Essential Guides”- CI/CD Integration - Automate architecture checks
- Policy Examples - Real-world policy configurations
- Breaking Cycles - Fix circular dependencies
- Troubleshooting - Common issues and solutions
Advanced Topics
Section titled “Advanced Topics”- Output Formats - JSON, HTML, SARIF, and more
- Presets - Pre-configured analysis profiles
- Baseline Comparison - Track changes over time
Architecture
Section titled “Architecture”Understanding how Arxo works:
- Architecture Overview - System design and data flow
- Graph Types - Import, call, and entity graphs
- Performance - Optimization and caching
API Reference
Section titled “API Reference”Complete command and configuration reference:
CLI Commands
Section titled “CLI Commands”- analyze - Run architecture analysis
- init - Initialize configuration
- config - Manage configuration
- metrics - List and explain metrics
- cache - Manage analysis cache
- doctor - Diagnose issues
- completions - Shell completions
Configuration
Section titled “Configuration”- Configuration Schema - Full YAML reference
- Policy Syntax - Policy rule syntax
- Metric IDs - All available metric identifiers
Integrations
Section titled “Integrations”- MCP - Model Context Protocol
- LSP Server - Language Server Protocol
- OpenAPI - REST API (if applicable)
Metrics
Section titled “Metrics”Documentation for all available metrics:
Structural Metrics
Section titled “Structural Metrics”- SCC (Strongly Connected Components) - Circular dependencies
- Centrality - Critical modules
- Modularity - Community structure
- Hierarchy - Layer violations
- Core-Periphery - Architectural zones
Coupling Metrics
Section titled “Coupling Metrics”- Propagation Cost - Change impact
- Coupling Analysis - Dependency coupling
- Flow Analysis - Structural, logical, and runtime dependency flow
- Ricci Curvature - Dependency bottlenecks and fragile edges
Quality Metrics
Section titled “Quality Metrics”- Architectural Smells - Anti-patterns
- Package Metrics - Martin’s metrics
- Visibility - Public API exposure and structural concentration risk
- Layer Violations - Boundary violations
- Test Coverage - Test metrics
Evolution Metrics
Section titled “Evolution Metrics”- MSR (Mining Software Repositories) - Git history analysis
- MSR includes hotspot and co-change signals - Hotspots, churn, and temporal coupling
AI/LLM Metrics
Section titled “AI/LLM Metrics”- LLM Architecture - LLM call analysis
- ML Architecture - ML system patterns
- Fine-tuning Architecture - Fine-tuning pipeline governance
- RAG Architecture - RAG pattern detection
- Agent Architecture - Agent pattern analysis
Security Metrics
Section titled “Security Metrics”- Security Vulnerabilities - Known vulnerabilities
- Sensitive Data Flow - PII tracking
Synthesis Metrics
Section titled “Synthesis Metrics”- L1 Overview - High-level summary
- Cross-Metric Insights - Combined analysis
- Refactoring Recommendations - Suggestions
Advanced Topics
Section titled “Advanced Topics”In-depth documentation for advanced users:
Language Support
Section titled “Language Support”- TypeScript/JavaScript Support - TS/JS specifics
- Python Support - Python specifics
- Rust Support - Rust specifics
- Java Support - Java specifics
- Kotlin Support - Kotlin specifics
- Go Support - Go specifics
Extensibility
Section titled “Extensibility”- Plugin Development - Create custom metrics
- Custom Detectors - Pattern detection
- Data Store API - Access internal data
Integration
Section titled “Integration”- GitHub Actions - GitHub integration
- GitLab CI - GitLab integration
- IDE - IDE integration
- Pre-commit Hooks - Git hooks
Use Case Guides
Section titled “Use Case Guides”Guides for specific project types:
Project Types
Section titled “Project Types”- Microservices - Service boundaries
- Monorepo - Multi-package projects
- React Applications - Frontend apps
- React Native Apps - Mobile apps
- Python Packages - Libraries
- AI/LLM Applications - LLM integrations
Architecture Patterns
Section titled “Architecture Patterns”- Feature-Sliced Design - FSD architecture
- Clean Architecture - Clean patterns
- Hexagonal Architecture - Ports and adapters
- Domain-Driven Design - DDD patterns
Scenarios
Section titled “Scenarios”- Legacy Refactoring - Modernizing codebases
- New Projects - Starting fresh
- Continuous Improvement - Incremental fixes
Concepts
Section titled “Concepts”Understanding key concepts:
- Metrics - What are metrics
- Policies - Policy system
- Graphs - Graph representations
- Presets - Analysis profiles
- Evidence - Metric findings
- Violations - Policy violations
- Grouping - File vs folder grouping
Migration Guides
Section titled “Migration Guides”Upgrading and migration:
- Migration from v0.0.x to v0.1.x - Breaking changes
- From Other Tools - Comparison and migration
Frequently asked questions:
- General FAQ - Common questions
- Performance FAQ - Performance questions
- Configuration FAQ - Configuration questions
Reference
Section titled “Reference”Quick reference materials:
- Glossary - Term definitions
- Metric Cheat Sheet - Quick metric reference
- Policy Operators - Operator reference
- Exit Codes - CLI exit codes
Contributing
Section titled “Contributing”Contributing to Arxo:
- Contributing Guide - How to contribute
- Code of Conduct - Community guidelines
- Development Setup - Local development
- Testing - Running tests
Search Tips
Section titled “Search Tips”Use the search bar above to find specific topics. Search examples:
- “circular dependencies” → Finds cycle-related documentation
- “policy” → Finds policy configuration guides
- “typescript” → Finds TypeScript-specific documentation
- “ci” → Finds CI/CD integration guides
Need Help?
Section titled “Need Help?”- Troubleshooting Guide - Common issues
- GitHub Discussions - Ask questions
- Issue Tracker - Report bugs
- Discord Community - Chat with users