Skip to content

README.md

Latest commit

 

History

History
158 lines (119 loc) · 5.83 KB

README.md

File metadata and controls

158 lines (119 loc) · 5.83 KB
Raw

A.R.C. CLI Documentation

Agent Runtime Core - Reliable Components for Resilient Architecture

Quick Start

# Install
go install github.com/arc-framework/arc-cli@latest

# Initialize workspace
arc init

# Run platform
arc workspace run

Get Started →

Documentation Structure

docs/
├── getting-started/          # Installation & first steps
│   └── index.md              # Quick start guide
│
├── user-guides/              # Feature guides for users
│   ├── workspace.md          # Workspace configuration
│   ├── themes.md             # Theme customization
│   └── animations.md         # Animation system
│
├── api-reference/            # Technical reference
│   └── services.md           # Service catalog (29 services)
│
├── developer/                # For contributors & extenders
│   ├── roadmap.md            # Feature development history
│   ├── ui-layout.md          # UI system internals
│   ├── templates.md          # Template system
│   └── adding-services.md    # How to add services
│
├── contributing/             # Contribution guidelines
│   ├── development.md        # Dev environment setup
│   ├── testing.md            # Testing patterns
│   ├── branching.md          # Git workflow
│   ├── ci-cd.md              # CI/CD pipelines
│   └── releases.md           # Release process
│
├── diagrams/                 # Architecture visualizations
│   ├── A1-A5                 # Architecture diagrams
│   ├── B1-B4                 # Data flow diagrams
│   ├── C1-C3                 # Pattern diagrams
│   └── D1-D3                 # Workflow diagrams
│
└── branding/                 # Brand assets
    ├── arc-icon.svg          # Logo
    ├── arc-wordmark.svg      # Logo with text
    └── ascii-banners.txt     # Terminal banners

By Audience

Users

Guide Description
Getting Started Installation and first commands
Workspace Configure your platform
Themes Customize appearance
Service Catalog Available services

Contributors

Guide Description
Development Setup and code quality
Testing Test patterns and coverage
Branching Git workflow
CI/CD Automation pipelines

Developers

Guide Description
Roadmap Feature history (specs 001-009)
UI Layout UI system internals
Templates Template system
Adding Services Extend the catalog

Architects

Diagram Description
CLI Architecture System overview
Two-Brain Separation CLI vs SDK boundary
Gardener Pattern Reconciliation lifecycle
All Diagrams Complete diagram index

Key Concepts

The A.R.C. Way

  1. Platform-in-a-Box - arc init bootstraps everything
  2. Two-Brain Separation - CLI handles infrastructure, Python SDK handles intelligence
  3. Declarative Reconciliation - arc.yaml is the single source of truth
  4. Deep Observability - Health checks verify actual readiness, not just "running"

Service Matrix

A.R.C. orchestrates 29+ services across 4 categories:

Category Examples Description
Infrastructure Heimdall, J.A.R.V.I.S., Nick Fury Gateway, Identity, Secrets
Data & Memory Oracle, Sonic, Cerebro Postgres, Redis, Vector DB
AI Workforce Sherlock, Scarlett, RoboCop Reasoning, Voice, Safety
Observability Dr. House, Watson, Friday Metrics, Logs, Dashboards

Full Service Catalog →

Related Resources

Resource Description
Main README Project overview
Specs Feature specifications
arc-info.md Platform architecture

Docusaurus

This documentation is structured for Docusaurus compatibility:

  • _category_.json files define sidebar navigation
  • Markdown files use Docusaurus-compatible frontmatter
  • No external dependencies required (just directory structure)

To build with Docusaurus:

# Future: when Docusaurus is added
npx create-docusaurus@latest docs-site classic
# Copy docs/ into docs-site/docs/

A.R.C. CLI • arc-framework/cli