Skip to content

Latest commit

 

History

History
89 lines (63 loc) · 3.57 KB

CLAUDE.md

File metadata and controls

89 lines (63 loc) · 3.57 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Agent OS Overview

Agent OS is a system for spec-driven agentic development that transforms AI coding agents into productive developers through structured workflows. This is the Agent OS framework itself - a collection of instructions, standards, and setup scripts for implementing Agent OS in other projects.

Project Structure

Core Directories

  • instructions/ - Core Agent OS workflow instructions for project planning, task creation, and execution
    • instructions/core/ - Main workflow files (analyze-product.md, create-spec.md, execute-task.md, etc.)
    • instructions/meta/ - Pre/post-flight checks
  • project_types/ - Project-specific configurations
    • project_types/wheels/ - Wheels framework integration with specialized instructions and standards
  • standards/ - Development standards and code style guidelines
  • setup/ - Installation and configuration scripts
  • commands/ - User-facing command files that reference instructions
  • claude-code/agents/ - Specialized agent definitions for Claude Code

Key Files

  • config.yml - Main configuration specifying project types and agent settings
  • setup/base.sh - Primary installation script with flags for Claude Code/Cursor integration

Configuration

The system uses config.yml to manage:

  • Agent OS version
  • Enabled agents (Claude Code, Cursor)
  • Project type configurations with instruction and standards paths
  • Default project type (currently set to "wheels")

Common Commands

Installation Commands

Install Agent OS with Claude Code support:

curl -sSL https://raw.githubusercontent.com/wheels-dev/agent-os/main/setup/base.sh | bash -s -- --claude-code

Install with Cursor support:

curl -sSL https://raw.githubusercontent.com/wheels-dev/agent-os/main/setup/base.sh | bash -s -- --cursor

Install with both:

curl -sSL https://raw.githubusercontent.com/wheels-dev/agent-os/main/setup/base.sh | bash -s -- --claude-code --cursor

Agent OS Workflows

Core workflow commands reference instruction files:

  • Analyze existing product: @.agent-os/instructions/core/analyze-product.md
  • Plan new product: @.agent-os/instructions/core/plan-product.md
  • Create spec: @.agent-os/instructions/core/create-spec.md
  • Create tasks: @.agent-os/instructions/core/create-tasks.md
  • Execute tasks: @.agent-os/instructions/core/execute-task.md

Architecture

Agent OS follows a layered architecture:

  1. Instructions Layer - Structured workflow templates with XML-like process flows
  2. Standards Layer - Development guidelines and code style rules with conditional blocks
  3. Project Types Layer - Specialized configurations for different frameworks (like Wheels)
  4. Setup Layer - Installation and configuration automation

The instructions use a templated approach with variables like [DERIVED_FROM_ANALYSIS] and structured process flows with numbered steps. Standards files include conditional logic to only load relevant sections based on context.

Wheels Integration

This fork includes specialized support for the Wheels framework:

  • Dedicated project type configuration
  • Wheels-specific instructions and standards
  • Default project type set to "wheels"

Development Notes

  • Instructions use XML-like structured markup for process flows
  • Standards include conditional blocks to optimize context usage
  • Setup scripts support multiple agent integrations
  • Configuration is centralized in config.yml
  • The system is designed to be extended with new project types