API Reference ClaudeWrapper v#0.13.0

Copy Markdown View Source

Modules

Elixir wrapper for the Claude Code CLI.

File-backed read/write access to Claude Code's on-disk agent definitions.

Full agent definition returned by ClaudeWrapper.Agents.get/2.

Lightweight metadata for one agent definition, returned by ClaudeWrapper.Agents.list/1.

Detect which auth strategy the Claude Code CLI will use, and classify auth-related CLI failures.

Snapshot of auth-relevant environment state.

Cumulative USD budget tracker with threshold callbacks.

Opt-in bundled-binary resolution for the claude CLI.

Parse and compare the claude CLI's reported version.

Behaviour for CLI commands.

claude agents command -- lists configured agents.

Authentication commands -- login, logout, status, token setup.

Auto-mode classifier inspection commands.

claude doctor command -- checks CLI health.

Install a Claude Code native build.

Plugin marketplace management commands.

MCP (Model Context Protocol) server management commands.

Plugin management commands.

Project state management commands.

claude ultrareview -- cloud-hosted multi-agent code review.

Check for CLI updates and install if available.

claude --version command.

Shared client configuration for the Claude CLI.

Host-side bookkeeping wrapper over a ClaudeWrapper.DuplexSession.

Opt-in wrapper for permission-bypass queries.

Interactive helpers for driving ClaudeWrapper.DuplexSession from IEx.

Long-lived claude session over the CLI's stream-json duplex protocol.

Default ClaudeWrapper.DuplexSession.Adapter: a real claude subprocess over an Erlang port.

Canonical error type for ClaudeWrapper.

Read-side access to Claude Code's on-disk session history.

Summary of one project directory under the history root.

A fully parsed session: an ordered list of ClaudeWrapper.History.entry/0.

Summary of one session .jsonl file.

Interactive helpers for conversational use in IEx.

Read-side access to Claude Code's on-disk background-job state.

One timeline event from a job's timeline.jsonl.

Full job record returned by ClaudeWrapper.Jobs.get/2.

Cheap metadata view of one background job, returned by ClaudeWrapper.Jobs.list/1. Stripped of the timeline.

Programmatic builder for .mcp.json configuration files.

Composable prompt builder with deferred file / git expansion.

Query command -- the primary interface for executing prompts.

Result from a completed query execution.

Retry policy with exponential backoff for query execution.

How claude subprocesses are executed.

Leak-free runner backed by forcola.

Default runner: System.cmd/3 for one-shot calls and a /bin/sh Port for NDJSON streaming.

Multi-turn session management.

GenServer wrapper for long-running multi-turn sessions.

Read-side access to Claude Code's on-disk settings files.

Read-side access to Claude Code's on-disk skill definitions.

Lightweight metadata for one skill, returned by ClaudeWrapper.Skills.list/1.

A single event from the Claude CLI's NDJSON streaming output.

Run a Claude call as a typed function.

:telemetry events emitted by ClaudeWrapper.

Drive a ClaudeWrapper.DuplexSession against an in-process double, with no claude binary and no network.

Tool permission patterns for --allowed-tools / --disallowed-tools.

Read-side introspection for git worktrees.

One git worktree as reported by git worktree list --porcelain.

Mix Tasks

Install the opt-in bundled claude CLI, pinned to ClaudeWrapper.Bundled.pinned_version/0, into the package's priv/bin/.

Print where the opt-in bundled claude binary lives, and whether it is installed.

Remove the opt-in bundled claude binary installed by mix claude_wrapper.install.