Start here if you are new to AgentForge.
This is the canonical public documentation hub. The path below starts with a no-credential smoke test, moves to the default Codex OAuth real-model setup, and then introduces Cogs before advanced reference material.
- Quickstart: Install AgentForge, scaffold
.agentforge/, and run a debug-mode smoke test without provider credentials. - First Real Model Run: Turn the same direct Agent path toward the default Codex OAuth model setup.
- Core Concepts: Build the mental model for Agents, prompts, settings, and Cogs.
- Beginner Cog Walkthrough: Move from one Agent to a small multi-agent workflow.
- Branch/Loop Cog Walkthrough: Add a decision branch, revision loop, fallback, and loop guard.
- Advanced Reference: Continue into optional memory, personas, storage, custom APIs, custom Agents, utilities, and legacy Tools/Actions.
- Using AgentForge: Project-root discovery,
.agentforge/ownership, debug smoke-test boundaries, and real-model setup boundaries. - Installation Details: Extra environment setup detail beyond the quickstart.
- Prerequisites Details: Optional credentials, local model services, and platform dependencies.
- Troubleshooting: Common setup and provider errors.
- Agents: Agent lifecycle, prompt files, and advanced subclass hooks.
- Cogs: Cog schema, flow transitions, branching, loops, return values, and memory configuration.
- Settings: System, model, and storage settings.
- APIs: Provider integration and advanced custom API hooks.
- Memory and Personas: Optional context systems.
- Storage, Utilities, and Tools & Actions: Advanced or compatibility references.
Internal contributor and agent guidance intentionally lives outside the public docs path in the repository's dev-docs/ tree.