ClaudeWrapper.Commands.Agents (ClaudeWrapper v0.11.0)

Copy Markdown View Source

claude agents command -- lists configured agents.

Usage

config = ClaudeWrapper.Config.new()

# Parsed list of agent names and models
{:ok, agents} = ClaudeWrapper.Commands.Agents.list(config)

# Raw CLI output
{:ok, output} = ClaudeWrapper.Commands.Agents.execute(config)

# Restrict which setting sources are loaded
{:ok, agents} = ClaudeWrapper.Commands.Agents.list(config, setting_sources: "user,project")

Summary

Types

agent()

Functions

execute(config, opts \\ [])

Run claude agents and return the raw output string.

list(config, opts \\ [])

Run claude agents and return the parsed agent list.

Types

agent()

@type agent() :: %{name: String.t(), model: String.t()}

Functions

execute(config, opts \\ [])

@spec execute(
  ClaudeWrapper.Config.t(),
  keyword()
) :: {:ok, String.t()} | {:error, term()}

Run claude agents and return the raw output string.

list(config, opts \\ [])

@spec list(
  ClaudeWrapper.Config.t(),
  keyword()
) :: {:ok, [agent()]} | {:error, term()}

Run claude agents and return the parsed agent list.

Options

  • :setting_sources - comma-separated setting sources to load (e.g. "user,project")

Examples

{:ok, agents} = ClaudeWrapper.Commands.Agents.list(config)
# => {:ok, [%{name: "Explore", model: "haiku"}, ...]}