jido

# Jido

[![Hex.pm](https://img.shields.io/hexpm/v/jido.svg)](https://hex.pm/packages/jido)
[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/jido/)
[![CI](https://github.com/agentjido/jido/actions/workflows/ci.yml/badge.svg)](https://github.com/agentjido/jido/actions/workflows/ci.yml)
[![License](https://img.shields.io/hexpm/l/jido.svg)](https://github.com/agentjido/jido/blob/main/LICENSE)
[![Website](https://img.shields.io/badge/website-jido.run-0f172a.svg)](https://jido.run)
[![Ecosystem](https://img.shields.io/badge/ecosystem-jido.run-0ea5e9.svg)](https://jido.run/ecosystem)
[![Discord](https://img.shields.io/badge/discord-join-5865F2.svg?logo=discord&logoColor=white)](https://jido.run/discord)

> **Jido is an autonomous agent framework for Elixir, built for workflows and multi-agent systems.**
<!-- package.jido.framework -->

Define agents, connect them to actions, signals, and directives, and run them
with supervision and fault tolerance built in.

_The name "Jido" (自動) comes from the Japanese word meaning "automatic" or "automated", where 自 (ji) means "self" and 動 (dō) means "movement"._

_Learn more about Jido at [jido.run](https://jido.run)._

## Overview

Jido helps you build agent systems as ordinary Elixir and OTP software.

- Agents hold state and implement `cmd/2`
- Actions do work and transform that state
- Signals route events into the system
- Directives describe effects for the runtime to execute

The purity boundary is the agent's decision logic: Jido keeps agent decisions and
state transitions explicit, actions may be pure or effectful, and directives are
for effects you want the runtime to own.

Use Jido when software needs to inspect context, choose among multiple steps,
coordinate with other agents, and keep running reliably over time.

AI is optional. The core package gives you the agent architecture and runtime;
companion packages such as `jido_ai` add model integration when you need it.

At the core, Jido agents are immutable data structures with a single command function:

```elixir
defmodule MyAgent do
  use Jido.Agent,
    name: "my_agent",
    description: "My custom agent",
    schema: [
      count: [type: :integer, default: 0]
    ]
end

{agent, directives} = MyAgent.cmd(agent, action)
```

State changes are explicit data transformations. If an action needs a result
back immediately to continue reasoning or update state, it may perform that work
itself. If the workflow has already decided on an outbound effect and wants the
runtime or integration layer to own delivery, return a directive.
<!-- package.jido.pure_cmd package.jido.runtime_separation -->

## The Jido Ecosystem

Jido is the core package of the Jido ecosystem. The ecosystem is built around the core Jido Agent behavior and offer several opt-in packages to extend the core behavior.

| Package                                                 | Description