jido AGENTS.md

A project guide for Jido, an Elixir and OTP system for building software agents. It describes the project’s architecture, commands, testing, quality checks, and work-tracking process.

In plain words
What is it for?
Use it when implementing or reviewing Jido code, running tests and quality checks, managing Beadwork tasks, and following the project’s architecture conventions.
Why use it?
It gives coding agents the rules they need to work consistently in the repository. It also explains how to record progress and validation so work survives across branches and sessions.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/agentjido/jido/agents-md
Clone the repo
git clone --depth 1 https://github.com/agentjido/jido

Made for: Codex, OpenCode.

Per session 480 This file is loaded in full into every session.
When invoked 480 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00480 $0.00480
Opus 5 $0.00240 $0.00240
Sonnet 5 $0.00096 $0.00096
Haiku 4.5 $0.00048 $0.00048

Measured today against content hash e54d0021b3ff, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

jido AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured today.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 47 lines

What it actually says

AGENTS.md - Jido Guide

Intent

Build reliable agent systems by separating pure decision logic from runtime side-effect execution.

Runtime Baseline

  • Elixir ~> 1.18
  • OTP 27+ (release QA baseline)

Commands

  • mix test (default alias excludes :flaky)
  • mix test --include flaky (full suite)
  • mix test --cover (coverage gate)
  • mix q or mix quality (format --check-formatted, compile --warnings-as-errors, credo, dialyzer)
  • mix docs (local docs)

Architecture Snapshot

  • Jido.Agent: pure agent module with immutable state and cmd/2
  • Jido.AgentServer: GenServer runtime for directives, lifecycle, and message flow
  • Jido.Agent.Directive.*: typed effect descriptors (Emit, SpawnAgent, StopChild, etc.)
  • Jido.Agent.StateOp.*: internal state transition operations applied by strategy layer
  • Plugins/sensors provide capability composition without coupling core agent logic

Standards

  • Keep cmd/2 pure: same input => same {agent, directives} output
  • Keep directives for external effects only; do not rely on directives for state mutation
  • Use Zoi-first schemas for new agent/plugin/signal contracts
  • Preserve tagged tuple and structured error contracts at public boundaries
  • Keep cross-agent communication on signals/directives, not ad-hoc process messages

Testing and QA

  • Prefer pure agent tests first, then AgentServer/runtime integration tests
  • Use helpers from test/AGENTS.md (JidoTest.Case, JidoTest.Eventually) for async assertions
  • Avoid Process.sleep/1 in tests; assert eventual state/event behavior

Release Hygiene

  • Keep semver ranges stable (~> 2.0 for Jido ecosystem peers)
  • Use Conventional Commits
  • Do not modify CHANGELOG.md; release notes are generated from Git history during release, so keep changes focused on proper Conventional Commits.

References

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. today Changed · -14 lines · -150 tokens per session e54d0021b3ff
  2. 3d ago First seen · 61 lines · 630 tokens per session scan A b8b9f924af06

Subscribe to this mod's changes

jido AGENTS.md is an instructions file published in the GitHub repository agentjido/jido (1,828 stars, last pushed today), licensed Apache-2.0. It adds 480 tokens to every session, about $0.0024 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.