Introduction to Arxo
Introduction
Section titled “Introduction”Arxo is a comprehensive architecture analysis tool that helps you understand, measure, and enforce architectural patterns in your codebase. It supports TypeScript/JavaScript and Python from a single binary.
What Is Arxo?
Section titled “What Is Arxo?”Arxo parses your source code, builds dependency and call graphs, and runs published metrics — today that means Agent Architecture and OpenClaw Architecture — to give you scores, findings, and policy guardrails for agent systems and OpenClaw-based skill platforms.
Reliability, governance, safety, and coordination for multi-agent and tool-calling systems.
Config security, skill governance, observability, and supply chain for OpenClaw skill ecosystems.
Key Features
Section titled “Key Features”Language Support
Section titled “Language Support”Arxo supports two language ecosystems:
- TypeScript / JavaScript — React, Next.js, Node.js, Bun
- Python — Django, Flask, FastAPI
Published Metrics
Section titled “Published Metrics”Only the following metrics are included in the public build:
| Metric | What it covers |
|---|---|
| agent_architecture | Agent and orchestration: reliability, governance, safety, coordination (scores and findings). |
| openclaw_architecture | OpenClaw platforms: config security, skill governance, observability, supply chain (scores and findings). |
Policy Enforcement
Section titled “Policy Enforcement”Define architectural rules in YAML and enforce them in CI/CD to prevent regressions:
policy: invariants: - metric: agent_architecture.overall_agent_health op: ">=" value: 70 message: "Agent architecture health at least 70" - metric: openclaw_architecture.overall_openclaw_health op: ">=" value: 60 message: "OpenClaw architecture health at least 60"Multiple Output Formats
Section titled “Multiple Output Formats”| Format | Use case |
|---|---|
| Console | Human-readable terminal output with pass/fail indicators |
| JSON | Machine-readable for CI/CD pipelines and custom tooling |
| HTML | Interactive web reports with dependency graph visualization |
Fast and Incremental
Section titled “Fast and Incremental”- Parallel computation — Metrics run concurrently across available cores.
- Cached results — Repeated analysis returns instantly until the cache TTL expires.
- Config-based — Use a config file or defaults to run agent_architecture and openclaw_architecture.
Quick Start
Section titled “Quick Start”Installation
Section titled “Installation”Install the pre-built binary from GitHub Releases, or use npm:
npm install -g arxoSee Installation for other options (Docker, direct download).
First Analysis
Section titled “First Analysis”# Agent and OpenClaw architecture (published metrics)arxo analyzeSample Output
Section titled “Sample Output”Analyzing project... Parsed 247 files Built dependency and call graph
Results: agent_architecture.overall_agent_health: 72 ✓ agent_architecture.governance_readiness: 85 ✓ openclaw_architecture.overall_openclaw_health: 68 ✓
No policy violationsHow It Works
Section titled “How It Works”- Compute Metrics
Run the published metrics: agent_architecture (reliability, governance, safety, coordination) and openclaw_architecture (config, skill governance, observability, supply chain).
- Evaluate Policies
Check each policy invariant against computed metric values. Report violations with expected vs. actual values.
- Report
Output results in your chosen format — Console, JSON, or HTML — and exit with a non-zero code if any invariant fails.
Core Concepts
Section titled “Core Concepts”Metrics (published)
Section titled “Metrics (published)”The public build includes two metrics:
- agent_architecture — Scores and findings for agent and orchestration code: reliability (loop guards, retries, observability), governance (tool policy, validation), safety (sandbox, MCP, A2A), and coordination (routing, fanout, state).
- openclaw_architecture — Scores and findings for OpenClaw-based skill platforms: config security, skill governance, observability, and supply chain (e.g. ClawHub provenance, metadata validation).
Deep links:
- OpenClaw Architecture
- OpenClaw Scoring and Keys
- OpenClaw Keys and possible values
- OpenClaw Remediation Playbook
Each metric emits numeric scores (e.g. 0–100) and optional findings (warnings with evidence).
Policies
Section titled “Policies”Declarative invariants that must hold. Each invariant references a metric value, a comparison operator, and a threshold:
invariants: - metric: agent_architecture.overall_agent_health op: ">=" value: 70 - metric: openclaw_architecture.overall_openclaw_health op: ">=" value: 60When an invariant fails, the CLI exits with a non-zero code and reports the violation — making it easy to use as a CI gate.
Running analysis
Section titled “Running analysis”Run arxo analyze to execute the published metrics (agent_architecture and openclaw_architecture). Use an arxo.yaml config file to customize which metrics run and policy thresholds; see Configuration.
Use Cases
Section titled “Use Cases”Development
Section titled “Development”- Pre-commit hooks — Run
arxo analyzeto gate on agent and OpenClaw architecture health. - IDE integration — The VS Code extension shows violations inline and provides a metrics dashboard.
- MCP for AI assistants — The MCP server lets Cursor, Claude, and other AI tools call architecture analysis directly.
- Pull request gates — Enforce policies automatically with
--fail-fast. - Reports — Export JSON or HTML reports for CI artifacts and review.
Architecture Review
Section titled “Architecture Review”- Agent systems — Score reliability, governance, safety, and coordination; use findings to fix gaps.
- OpenClaw platforms — Score config security, skill governance, observability, and supply chain; improve over time with policy gates.
Example Scenarios
Section titled “Example Scenarios”Gate agent architecture health
Section titled “Gate agent architecture health”policy: invariants: - metric: agent_architecture.overall_agent_health op: ">=" value: 70 message: "Agent architecture health at least 70"arxo analyze --fail-fastGate OpenClaw architecture health
Section titled “Gate OpenClaw architecture health”policy: invariants: - metric: openclaw_architecture.overall_openclaw_health op: ">=" value: 60 message: "OpenClaw architecture health at least 60"arxo analyze --fail-fastNext Steps
Section titled “Next Steps”Install Arxo with pre-built binaries.
Quick StartRun your first analysis in under a minute.
ConfigurationSet up metrics, policies, and output formats.
Metrics ReferenceBrowse available metrics and interpretation guides.
Integration
Section titled “Integration”- CI/CD Integration — Automate checks in GitHub Actions, GitLab CI, and Jenkins.
- VS Code Extension — Real-time analysis, inline violations, and metrics dashboard.
- MCP Server — Architecture analysis for AI assistants (Cursor, Claude Desktop).
Guides
Section titled “Guides”- Policy Examples — Real-world policy configurations.
- Output Formats — Console, JSON, and HTML.
- Troubleshooting — Common issues and solutions.
Community and Support
Section titled “Community and Support”- GitHub: github.com/arxohq/arxo
- Issues: github.com/arxohq/arxo/issues
- Discussions: github.com/arxohq/arxo/discussions