# beam_agent_ex v0.1.0 - Table of Contents

Canonical Elixir wrapper for the consolidated beam_agent SDK

## Pages

- [BeamAgent](readme.md)
- [Backend Integration Guide](backend_integration_guide.md)
- [Canonical Domain Guide](canonical_domain_guide.md)
- [Contributing to BEAM Agent](contributing.md)
- [LICENSE](license.md)

## Modules

- [BeamAgent.Credential](BeamAgent.Credential.md): Cookie generation and credential encryption helpers.
- [BeamAgent.Store](BeamAgent.Store.md): Store adapter boundary for canonical BeamAgent domains.

- Public API
  - [BeamAgent](BeamAgent.md): Unified public API for the BeamAgent SDK -- an Elixir/OTP wrapper around five
agentic coder backends: Claude, Codex, Gemini, OpenCode, and Copilot.
  - [BeamAgent.Account](BeamAgent.Account.md): Account management for the BeamAgent SDK.
  - [BeamAgent.Agents](BeamAgent.Agents.md): Agent type management for the BeamAgent SDK.
  - [BeamAgent.Apps](BeamAgent.Apps.md): App and project management for the BeamAgent SDK.
  - [BeamAgent.Capabilities](BeamAgent.Capabilities.md): Capability metadata for the BeamAgent SDK.
  - [BeamAgent.Catalog](BeamAgent.Catalog.md): Catalog accessors for tools, skills, plugins, MCP servers, and agents.
  - [BeamAgent.Checkpoint](BeamAgent.Checkpoint.md): File checkpointing and rewind for the BeamAgent SDK.
  - [BeamAgent.Command](BeamAgent.Command.md): Shell command execution for the BeamAgent SDK.
  - [BeamAgent.Config](BeamAgent.Config.md): Configuration management for the BeamAgent SDK.
  - [BeamAgent.Content](BeamAgent.Content.md): Content block conversion and message normalisation for the BeamAgent SDK.
  - [BeamAgent.Control](BeamAgent.Control.md): Control plane for session configuration, permissions, tasks, and feedback.
  - [BeamAgent.File](BeamAgent.File.md): File operations for the BeamAgent SDK.
  - [BeamAgent.Hooks](BeamAgent.Hooks.md): SDK lifecycle hooks for the BeamAgent SDK.
  - [BeamAgent.MCP](BeamAgent.MCP.md): In-process MCP (Model Context Protocol) support for the BeamAgent SDK.
  - [BeamAgent.Plugins](BeamAgent.Plugins.md): Plugin management for the BeamAgent SDK.
  - [BeamAgent.Provider](BeamAgent.Provider.md): Provider and agent management for the BeamAgent SDK.
  - [BeamAgent.Raw](BeamAgent.Raw.md): Minimal escape-hatch namespace for transport-level and debug access only.
  - [BeamAgent.Runtime](BeamAgent.Runtime.md): Runtime state management for providers and agents.
  - [BeamAgent.SDKConfig](BeamAgent.SDKConfig.md): Global SDK configuration for the BeamAgent SDK.
  - [BeamAgent.Search](BeamAgent.Search.md): Fuzzy file search for the BeamAgent SDK.
  - [BeamAgent.SessionStore](BeamAgent.SessionStore.md): Unified session history store for the BeamAgent SDK.
  - [BeamAgent.Skills](BeamAgent.Skills.md): Skill management for the BeamAgent SDK.
  - [BeamAgent.SlashCommands](BeamAgent.SlashCommands.md): Slash command management for the BeamAgent SDK.
  - [BeamAgent.Telemetry](BeamAgent.Telemetry.md): OpenTelemetry-style span and event emission for the BeamAgent SDK.
  - [BeamAgent.Threads](BeamAgent.Threads.md): Conversation thread lifecycle management for the BeamAgent SDK.
  - [BeamAgent.Todo](BeamAgent.Todo.md): Todo tracking helpers for BeamAgent message streams.

- Canonical Domains
  - [BeamAgent.Artifacts](BeamAgent.Artifacts.md): Canonical artifact and context store for BeamAgent.
  - [BeamAgent.Audit](BeamAgent.Audit.md): Canonical BeamAgent audit records.
  - [BeamAgent.Context](BeamAgent.Context.md): Elixir facade for canonical BeamAgent context management.
  - [BeamAgent.Journal](BeamAgent.Journal.md): Durable event journal for BeamAgent.
  - [BeamAgent.Memory](BeamAgent.Memory.md): Canonical long-term memory for BeamAgent.
  - [BeamAgent.Orchestrator](BeamAgent.Orchestrator.md): Canonical BeamAgent orchestration primitives.
  - [BeamAgent.Policy](BeamAgent.Policy.md): Canonical BeamAgent policy profiles and deterministic evaluation.
  - [BeamAgent.Routines](BeamAgent.Routines.md): Canonical routines and scheduled execution for BeamAgent.
  - [BeamAgent.Routing](BeamAgent.Routing.md): Elixir facade for canonical BeamAgent backend routing.
  - [BeamAgent.Runs](BeamAgent.Runs.md): Canonical run and step lifecycle for BeamAgent.

- Backend Wrappers
  - [ClaudeEx](ClaudeEx.md): Elixir wrapper for the Claude Code agent SDK.
  - [ClaudeEx.Session](ClaudeEx.Session.md): Direct access to the underlying `claude_agent_session` gen_statem.
  - [CodexEx](CodexEx.md): Elixir wrapper for the Codex CLI agent SDK.
  - [CodexEx.Session](CodexEx.Session.md): Direct access to the underlying Codex gen_statem modules.
  - [CopilotEx](CopilotEx.md): Elixir wrapper for the Copilot CLI agent SDK.
  - [CopilotEx.Session](CopilotEx.Session.md): Direct access to the underlying `copilot_session` gen_statem.
  - [GeminiEx](GeminiEx.md): Elixir wrapper for the Gemini CLI agent SDK.
  - [GeminiEx.Session](GeminiEx.Session.md): Direct access to the underlying `gemini_cli_session` gen_statem.
  - [OpencodeEx](OpencodeEx.md): Elixir wrapper for the OpenCode HTTP agent SDK.
  - [OpencodeEx.Session](OpencodeEx.Session.md): Direct access to the underlying `opencode_session` gen_statem.