AOF Documentation Index

Complete documentation for the Agentic Ops Framework (AOF).

Love AOF? Help us grow by starring us on GitHub! Your support helps more DevOps engineers discover AI-powered automation.

Documentation Structure

Main README

• Project README - Project overview, quick install, 30-second example

Getting Started

• Getting Started - 5-minute quickstart guide
  • Installation options (cargo, binary, source)
  • API key configuration
  • First agent creation and execution
  • Common troubleshooting

Core Concepts

• Core Concepts - Understanding AOF fundamentals
  • Agents - Single AI assistants
  • AgentFleets - Teams of agents working in parallel
  • AgentFlows - Event-driven workflow automation
    • Multi-tenant routing (channel, user, pattern filtering)
    • Execution context (kubeconfig, namespace, env vars)
  • Tools - MCP, Shell, HTTP, integrations
  • Models - Multi-provider support
  • Memory - Context persistence

Tutorials (Step-by-Step)

1. Build Your First Agent (15 min)

   • Agent definition and configuration
   • Adding tools (Shell, MCP)
   • Memory management
   • Deployment and testing

2. Create a Slack Bot (20 min)

   • Slack app setup
   • Event handling
   • Human-in-the-loop approvals
   • Interactive features

3. Incident Response Flow (30 min)

   • PagerDuty integration
   • Auto-diagnostics
   • Conditional remediation
   • Post-incident analysis

Reference Documentation

• Agent YAML Spec - Complete Agent specification

  • Metadata fields
  • Model configuration
  • Instructions best practices
  • All tool types (Shell, HTTP, MCP, Slack, GitHub, etc.)
  • Memory types and configuration
  • Complete examples

• AgentFlow YAML Spec - Complete AgentFlow specification

  • Trigger types (Webhook, Schedule, Slack, GitHub, etc.)
  • Trigger filtering (channels, users, patterns for multi-tenant routing)
  • Execution context (kubeconfig, namespace, cluster, env vars)
  • Node types (Agent, Fleet, HTTP, Shell, Conditional, etc.)
  • Connections and conditions
  • Variable interpolation
  • Error handling

• aofctl CLI Reference - Complete CLI command reference

  • Agent commands (apply, get, run, describe, logs, etc.)
  • Examples and troubleshooting

Examples (Copy-Paste Ready)

• Examples Overview - Overview of all examples with copy-paste YAML

Recommended Reading Path

For First-Time Users:

1. Start with Project README - Understand what AOF is
2. Follow Getting Started - Get up and running
3. Read Core Concepts - Understand the building blocks
4. Try First Agent Tutorial - Hands-on practice

For Production Deployment:

1. Review Agent Spec - Understand all options
2. Study Examples - See production patterns
3. Check CLI Reference - Master the tools

Documentation by Role

DevOps Engineers

Essential reading:

• Getting Started
• Examples
• Agent Spec (Tools section)

SRE Teams

Essential reading:

• Core Concepts
• Incident Response Tutorial
• Examples

Platform Engineers

Essential reading:

• AgentFlow Spec
• Examples
• CLI Reference
• All tutorials

Quick Reference

Common Tasks

Task	Documentation
Install AOF	Getting Started
Create first agent	First Agent Tutorial
Add kubectl tools	Agent Spec - Tools
Build Slack bot	Slack Bot Tutorial
Multi-tenant bot routing	AgentFlow Spec - Trigger Filtering
Setup auto-remediation	Incident Response Tutorial
CLI commands	aofctl Reference

Model Providers

Provider	Format	Env Variable
Google	google:gemini-2.5-flash	GOOGLE_API_KEY
OpenAI	google:gemini-2.5-flash	OPENAI_API_KEY
Anthropic	anthropic:claude-3-5-sonnet-20241022	ANTHROPIC_API_KEY
Ollama	ollama:llama3	None (local)

Built-in Tools

Tool	Description
shell	Execute shell commands
read_file	Read file contents
list_directory	List directory contents
git	Execute git commands

Getting Help

1. Check documentation - Search this index
2. Review examples - See Examples
3. Troubleshooting - Check each tutorial's troubleshooting section
4. GitHub Issues - Report bugs or request features
5. Discussions - Ask questions

---

Questions? Start with Getting Started or jump to a Tutorial.

Building something? Check the Examples for copy-paste templates.

Need details? See the Reference Documentation.