docs

MagAgent Documentation

This directory is the GitHub-facing documentation index for people browsing the repository.

MagAgent also ships a packaged offline docs bundle. Those source files live in src/magent/docs and are available after install with:

magent docs list
magent docs show overview
magent docs search "memory inbox"
magent docs doctor

Core Docs

• Overview
• Tutorial
• Commands
• Generated Command Reference
• Generated Provider Reference
• Generated Config Reference
• Configuration
• Troubleshooting
• Performance
• Installation Shapes
• Prompt Caching
• Open Agent Profiles Includes the interactive profile wizard, default-profile selection, OAP authoring, trust, and state review.
• Hooks
• Code Intelligence
• Background Worker
• Plugins
• Desktop Integration
• Agentic Graphs
• Security And Hardening
• Threat Model
• Compatibility And State Migration
• Release Supply Chain
• MagAgent 1.0.0 Web UI Release
• MagAgent 0.99.0 OAP/AGS Alignment
• MagAgent 0.34.0 Release Record
• MagAgent 0.35.0 Release Record
• MagAgent 0.35.1 Release Record
• MagAgent 0.50.0 Release Record
• MagAgent 0.60.0 Release Record
• MagAgent 0.70.0 Release Record
• MagAgent 0.80.0 Release Record
• MagAgent 0.90.0 Release Record
• MagAgent 0.91.0 Release Record
• MagAgent 0.93.0 Release Record
• MagAgent 0.94.0 Release Record
• MagAgent 0.96.0 Graph Board Contract
• MagAgent 0.98.0 Durable Web Workspace
• MagAgent 0.97.0 Local Web Workspace
• MagAgent 0.95.0 Release Candidate

Common setup tasks now have CLI-first flows:

magent get-started
magent provider set openai --model gpt-5 --api-key-env OPENAI_API_KEY
magent provider matrix
magent provider recommend --goal coding
magent provider models openrouter --refresh
magent provider test-matrix
magent provider set openai --model gpt-5 --access codex
magent provider cooldowns
magent model set-role review anthropic/claude-sonnet-5
magent model set-role image_maker openai/gpt-image-1
magent model health
magent model capabilities
magent model image-wizard
magent auth add openai
magent memory configure --mode inbox-first
magent permission status
magent config validate
magent config propose "use manual memory and paranoid permissions"
magent config proposals
magent gateway configure telegram --bot-token "$TELEGRAM_BOT_TOKEN"
magent subagent configure --max 3 --parallel 2
magent agent create review-helper
magent hook init
magent lsp diagnostics
magent daemon enqueue shell "pytest -q"
magent plugin list
magent plugin mcp import ./mcp.toml --name filesystem
magent plugin import codex-skill ./SKILL.md
magent plugin import pi ./pi-package
magent project init
magent config backup
magent events list
magent next
magent graph generate "repair the failing tests" --out repair.agraph.yaml
magent graph validate repair.agraph.yaml --strict
magent graph plan repair.agraph.yaml

Both magent configure and magent provider wizard discover models for the selected provider after credential setup. Choose a number, enter /search words to narrow a large provider catalog, or type an exact model ID. Cached and built-in defaults keep this flow usable when discovery is unavailable.

All interactive wizards explain their choices in context. The profile wizard describes OAP scope, inheritance, tools, permissions, memory, delegation, writeback, and default selection before asking. Gateway setup covers user/channel allowlists rather than tokens alone. See Configuration for the full wizard map.

Architecture And Workflow

• MagAgent Roadmap to 1.0
• Architecture
• Architecture Exceptions
• Workbench
• Context Map
• Project Playbooks
• Recipes
• Sandboxed Execution
• Evals
• Release Policy
• Known Limitations
• Patch Workflow
• Checkpoints
• Testing And Reliability

Memory And Tools

• Memory
• Semantic Memory
• Tool Capability Packs
• Browser Automation
• GitHub Workflows
• Comparisons

Interfaces

• Terminal UI
• Local UI

Gateway Setup

• Slack Gateway
• Discord Gateway
• Telegram Gateway

Skill Docs

MagAgent includes repo-level skill documentation under docs/skills. These files describe task-specific patterns for document generation, spreadsheets, PDFs, images, video/audio, data analysis, REST APIs, SQLite, desktop automation, and Git workflows.

Screenshots, Demos, And Examples

• Cockpit screenshot mockup
• Cockpit demo GIF
• Release prep recipe example

Keeping Docs Current

Before pushing documentation or command changes, run:

magent docs doctor
magent docs generate-reference --out src/magent/docs/command-reference.md
magent docs generate-config --out src/magent/docs/config-reference.md

The docs doctor checks that the packaged docs contain required topics and mention the live Typer command tree. The generated reference commands keep the GitHub-facing command and config references synchronized with the installed CLI.