Docs

Docs

These pages are generated straight from the documentation/ directory of the agents-exe repository: the repository is always the canonical source, and may be ahead of what is published here.

The map below shows how the documents and the modules they describe relate, to help you choose where to start.

Using agents-exe

• Command reference: the global options and every command, from the README.
• CLI reference: the same commands in depth, with their options and examples.
• Advanced configuration: agents-exe.cfg.json, agent directories, and per-project settings.
• The TUI: the terminal UI.
• agents-server: agents over HTTP, durable sessions, event streams, the chat page, MCP over HTTP, running as a service.
• MCP: agents-exe as an MCP server, and MCP servers as tool providers.
• Export and import: moving sessions and agents between stores.

Tools and agents

• Tool system: how tools are registered and exposed to the model.
• Executable-program tools: the self-description protocol a program follows to become a tool.
• Parameters, bindings and narrowing sub-agents: pre-bound arguments, declared parameters, and narrowed helpers.
• Internal tool mapping: the built-in system toolbox and what each capability maps to.
• File loader: how agent files and directories are discovered and loaded.

Sessions and workflows

• Session management: turns, storage, and resuming.
• Asynchronous tool calls: deferred and background calls, and how a run yields on them.
• Durable workflows how-to: the patterns for long-running, resumable work.
• Iterative development workflow: the build, check and run loop while writing agents.

Under the hood

• Architecture: the layers and the OS model.
• OS model API reference: entities, components, resources and conversations.
• OS model migration guide and its changelog: how the codebase moved onto the OS model.
• Migration guide: earlier breaking changes and how to follow them.
• SQQ agent flow and issue dependencies as a DAG: notes from the issue-processing agent.

For people and agents working in the code

• Agents, the framework overview: the docs/ directory’s own index.
• AI context and AI assistant guidelines: the conventions and context an assistant should load before changing the code.

Two more documents exist only in the repository:

• CHANGELOG.md: release history.
• todos/: the design documents, indexed on the Specs page with what of each has shipped.