Vibe.Agent.Jido (vibe v0.2.3)

Copy Markdown View Source

Jido agent server lifecycle bridge.

Summary

Functions

Returns the default plugins for agents bound to this Jido instance.

Returns the storage configuration for this Jido instance.

Returns the count of running agents under this Jido instance.

Returns the AgentSupervisor name for this Jido instance.

Returns the runtime config for this Jido instance.

Controls debug mode for this Jido instance.

Returns the current debug status for this instance.

Hibernate an agent to storage.

Lists all agents under this Jido instance.

Returns recent debug events from an agent's ring buffer.

Returns the Registry name for this Jido instance.

Returns the RuntimeStore name for this Jido instance.

Starts an agent under this Jido instance.

Stops an agent (by pid or id) under this Jido instance.

Returns the TaskSupervisor name for this Jido instance.

Thaw an agent from storage.

Looks up an agent by ID under this Jido instance.

Functions

__default_plugins__()

@spec __default_plugins__() :: [module() | {module(), map()}]

Returns the default plugins for agents bound to this Jido instance.

__jido_storage__()

@spec __jido_storage__() :: {module(), keyword()}

Returns the storage configuration for this Jido instance.

agent_count(opts \\ [])

@spec agent_count(keyword()) :: non_neg_integer()

Returns the count of running agents under this Jido instance.

agent_supervisor_name()

@spec agent_supervisor_name() :: atom()

Returns the AgentSupervisor name for this Jido instance.

config(overrides \\ [])

@spec config(keyword()) :: keyword()

Returns the runtime config for this Jido instance.

Configuration is loaded from config :vibe, Vibe.Agent.Jido and overridden by any runtime options passed in.

debug()

@spec debug() :: Jido.Debug.level()

Controls debug mode for this Jido instance.

  • debug() — returns current debug level
  • debug(:on) — enable developer-friendly verbosity
  • debug(:verbose) — enable maximum detail
  • debug(:off) — disable debug overrides
  • debug(pid) — toggle per-agent debug mode
  • debug(:on, redact: false) — also disable redaction

debug(pid)

@spec debug(Jido.Debug.level() | pid()) :: :ok | {:error, term()} | Jido.Debug.level()

debug(level, opts)

@spec debug(
  Jido.Debug.level(),
  keyword()
) :: :ok

debug_status()

@spec debug_status() :: map()

Returns the current debug status for this instance.

hibernate(agent, opts \\ [])

@spec hibernate(
  Jido.Agent.t(),
  keyword()
) :: :ok | {:error, term()}

Hibernate an agent to storage.

list_agents(opts \\ [])

@spec list_agents(keyword()) :: [{String.t(), pid()}]

Lists all agents under this Jido instance.

recent(pid, limit \\ 50)

@spec recent(pid(), non_neg_integer()) :: {:ok, [map()]} | {:error, term()}

Returns recent debug events from an agent's ring buffer.

registry_name()

@spec registry_name() :: atom()

Returns the Registry name for this Jido instance.

runtime_store_name()

@spec runtime_store_name() :: atom()

Returns the RuntimeStore name for this Jido instance.

start_agent(agent, opts \\ [])

@spec start_agent(
  module() | struct(),
  keyword()
) :: DynamicSupervisor.on_start_child()

Starts an agent under this Jido instance.

stop_agent(pid_or_id, opts \\ [])

@spec stop_agent(
  pid() | String.t(),
  keyword()
) :: :ok | {:error, :not_found}

Stops an agent (by pid or id) under this Jido instance.

task_supervisor_name()

@spec task_supervisor_name() :: atom()

Returns the TaskSupervisor name for this Jido instance.

thaw(agent_module, key, opts \\ [])

@spec thaw(module(), term(), keyword()) :: {:ok, Jido.Agent.t()} | {:error, term()}

Thaw an agent from storage.

whereis(id, opts \\ [])

@spec whereis(
  String.t(),
  keyword()
) :: pid() | nil

Looks up an agent by ID under this Jido instance.