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
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 - Practical workflow for removing circular dependencies
- Output Formats - Console, JSON, and HTML
- Running Analysis - How to run agent and OpenClaw analysis
- Troubleshooting - Common issues and solutions
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
API Docs
Section titled “API Docs”- API Introduction - CLI and command reference overview
- OpenAPI - OpenAPI spec
Integrations
Section titled “Integrations”- MCP - Model Context Protocol
- IDE (VS Code) - VS Code integration
Metrics
Section titled “Metrics”Documentation for currently published core and AI/observability metrics:
Core Structural Metrics
Section titled “Core Structural Metrics”- SCC (Strongly Connected Components) - Circular dependencies
- Propagation Cost - Change impact
- Centrality - Critical modules
- Flow Analysis - Structural, logical, and runtime dependency flow
- Coupling Analysis - Dependency coupling
AI and Observability Metrics
Section titled “AI and Observability Metrics”- Agent Architecture - Agent pattern analysis
- OpenClaw Architecture - OpenClaw architecture checks
Concepts
Section titled “Concepts”Understanding key concepts:
- Metrics - What are metrics
- Policies - Policy system
- Running Analysis - How analysis runs
- Evidence - Metric findings
- Violations - Policy violations
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