Current section
Files
Jump to
Current section
Files
mix.exs
defmodule Jido.MixProject do
use Mix.Project
@version "2.3.2"
def vsn do
@version
end
def project do
[
app: :jido,
version: @version,
elixir: "~> 1.18",
elixirc_paths: elixirc_paths(Mix.env()),
start_permanent: Mix.env() == :prod,
aliases: aliases(),
deps: deps(),
# Docs
name: "Jido",
description:
"An autonomous agent framework for Elixir, built for workflows and multi-agent systems.",
source_url: "https://github.com/agentjido/jido",
homepage_url: "https://github.com/agentjido/jido",
package: package(),
docs: docs(),
# Coverage
test_coverage: [
tool: ExCoveralls,
summary: [threshold: 80],
export: "cov",
ignore_modules: [~r/^JidoTest\./]
],
# Dialyzer
dialyzer: [
plt_add_apps: [:mix]
]
]
end
# Run "mix help compile.app" to learn about applications.
def application do
[
extra_applications: [:crypto, :logger],
mod: {Jido.Application, []}
]
end
def cli do
[
preferred_envs: [
coveralls: :test,
"coveralls.github": :test,
"coveralls.lcov": :test,
"coveralls.detail": :test,
"coveralls.post": :test,
"coveralls.html": :test,
"coveralls.cobertura": :test
]
]
end
# Specifies which paths to compile per environment.
defp elixirc_paths(:test), do: ["lib", "test/support"]
defp elixirc_paths(_), do: ["lib"]
defp docs do
[
main: "readme",
api_reference: false,
source_ref: "v#{@version}",
source_url: "https://github.com/agentjido/jido",
authors: ["Mike Hostetler <mike.hostetler@gmail.com>"],
groups_for_extras: [
"Start Here": [
"guides/getting-started.livemd",
"guides/core-loop.md",
"guides/runtime-patterns.md",
"guides/your-first-plugin.md",
"guides/your-first-sensor.md",
"guides/observability-intro.md"
],
Fundamentals: [
"guides/agents.md",
"guides/actions.md",
"guides/signals.md",
"guides/directives.md",
"guides/state-ops.md",
"guides/plugins.md",
"guides/strategies.md",
"guides/runtime.md"
],
Coordination: [
"guides/await.md",
"guides/orchestration.md",
"guides/pods.md",
"guides/multi-tenancy.md"
],
Operations: [
"guides/debugging.md",
"guides/observability.md",
"guides/testing.md",
"guides/configuration.md",
"guides/storage.md",
"guides/worker-pools.md",
"guides/scheduling.md"
],
Extending: [
"guides/sensors.md",
"guides/discovery.md",
"guides/custom-strategies.md"
],
Integrations: [
"guides/phoenix-integration.md",
"guides/ash-integration.md"
],
Advanced: [
"guides/orphans.md",
"guides/fsm-strategy.livemd",
"guides/errors.md"
],
Migration: [
"guides/migration.md"
],
Project: [
"CONTRIBUTING.md",
"CHANGELOG.md",
"LICENSE"
]
],
extras: [
{"README.md", title: "Home"},
# Start Here
{"guides/getting-started.livemd", title: "Quick Start"},
{"guides/core-loop.md", title: "Core Loop"},
{"guides/runtime-patterns.md", title: "Choosing a Runtime Pattern"},
{"guides/your-first-plugin.md", title: "Your First Plugin"},
{"guides/your-first-sensor.md", title: "Your First Sensor"},
{"guides/observability-intro.md", title: "Seeing What Happened"},
# Fundamentals
{"guides/agents.md", title: "Agents"},
{"guides/actions.md", title: "Actions"},
{"guides/signals.md", title: "Signals & Routing"},
{"guides/directives.md", title: "Directives"},
{"guides/state-ops.md", title: "State Operations"},
{"guides/plugins.md", title: "Plugins"},
{"guides/strategies.md", title: "Strategies"},
{"guides/runtime.md", title: "Runtime"},
# Coordination
{"guides/await.md", title: "Await & Coordination"},
{"guides/orchestration.md", title: "Multi-Agent Orchestration"},
{"guides/pods.md", title: "Pods"},
{"guides/multi-tenancy.md", title: "Multi-Tenancy"},
# Operations
{"guides/debugging.md", title: "Debugging"},
{"guides/observability.md", title: "Observability"},
{"guides/testing.md", title: "Testing"},
{"guides/configuration.md", title: "Configuration"},
{"guides/storage.md", title: "Persistence & Storage"},
{"guides/worker-pools.md", title: "Worker Pools"},
{"guides/scheduling.md", title: "Scheduling"},
# Extending
{"guides/sensors.md", title: "Sensors"},
{"guides/discovery.md", title: "Discovery"},
{"guides/custom-strategies.md", title: "Custom Strategies"},
# Integrations
{"guides/phoenix-integration.md", title: "Phoenix Integration"},
{"guides/ash-integration.md", title: "Ash Integration"},
# Advanced
{"guides/orphans.md", title: "Orphans & Adoption"},
{"guides/fsm-strategy.livemd", title: "FSM Strategy Deep Dive"},
{"guides/errors.md", title: "Error Handling"},
# Migration
{"guides/migration.md", title: "Migrating from 1.x"},
# Project
{"CONTRIBUTING.md", title: "Contributing"},
{"CHANGELOG.md", title: "Changelog"},
{"LICENSE", title: "Apache 2.0 License"}
],
extra_section: "Guides",
formatters: ["html", "markdown"],
skip_undefined_reference_warnings_on: [
"CHANGELOG.md",
"LICENSE"
],
groups_for_modules: [
Core: [
Jido,
Jido.Agent,
Jido.AgentServer,
Jido.Await,
Jido.Pod,
Jido.Pod.Topology,
Jido.Pod.Topology.Link,
Jido.Pod.Topology.Node
],
Strategies: [
Jido.Agent.Strategy,
Jido.Agent.Strategy.Direct,
Jido.Agent.Strategy.FSM,
Jido.Agent.Strategy.FSM.Machine,
Jido.Agent.Strategy.State,
Jido.Agent.Strategy.Snapshot
],
Plugins: [
Jido.Plugin,
Jido.Plugin.Config,
Jido.Plugin.Instance,
Jido.Plugin.Manifest,
Jido.Plugin.Requirements,
Jido.Plugin.Routes,
Jido.Plugin.Schedules,
Jido.Plugin.Spec,
Jido.Pod.Plugin
],
"Agent Identity": [
Jido.Agent.Identity,
Jido.Agent.Identity.Plugin,
Jido.Agent.Identity.Agent,
Jido.Agent.Identity.Profile,
Jido.Agent.Identity.Actions.Evolve
],
Directives: [
Jido.Agent.Directive,
Jido.Agent.Directive.Emit,
Jido.Agent.Directive.Error,
Jido.Agent.Directive.Spawn,
Jido.Agent.Directive.SpawnAgent,
Jido.Agent.Directive.AdoptChild,
Jido.Agent.Directive.StopChild,
Jido.Agent.Directive.Schedule,
Jido.Agent.Directive.RunInstruction,
Jido.Agent.Directive.Stop,
Jido.Agent.Directive.Cron,
Jido.Agent.Directive.CronCancel
],
"State Operations": [
Jido.Agent.StateOp,
Jido.Agent.StateOp.SetState,
Jido.Agent.StateOp.ReplaceState,
Jido.Agent.StateOp.DeleteKeys,
Jido.Agent.StateOp.SetPath,
Jido.Agent.StateOp.DeletePath,
Jido.Agent.StateOps
],
"Agent Internals": [
Jido.Agent.DefaultPlugins,
Jido.Agent.State,
Jido.Agent.Schema,
Jido.AgentServer.State,
Jido.AgentServer.State.Lifecycle,
Jido.AgentServer.Status,
Jido.AgentServer.Options,
Jido.AgentServer.ErrorPolicy,
Jido.AgentServer.SignalRouter,
Jido.AgentServer.ParentRef,
Jido.AgentServer.ChildInfo,
Jido.AgentServer.DirectiveExec,
Jido.AgentServer.Lifecycle,
Jido.AgentServer.Lifecycle.Keyed,
Jido.AgentServer.Lifecycle.Noop,
Jido.AgentServer.Signal.ChildStarted,
Jido.AgentServer.Signal.ChildExit,
Jido.AgentServer.Signal.CronTick,
Jido.AgentServer.Signal.Orphaned,
Jido.AgentServer.Signal.Scheduled
],
"Built-in Actions": [
Jido.Actions.Control,
Jido.Actions.Control.Broadcast,
Jido.Actions.Control.Cancel,
Jido.Actions.Control.Forward,
Jido.Actions.Control.Noop,
Jido.Actions.Control.Reply,
Jido.Actions.Lifecycle,
Jido.Actions.Lifecycle.NotifyParent,
Jido.Actions.Lifecycle.NotifyPid,
Jido.Actions.Lifecycle.SpawnChild,
Jido.Actions.Lifecycle.StopChild,
Jido.Actions.Lifecycle.StopSelf,
Jido.Actions.Scheduling,
Jido.Actions.Scheduling.CancelCron,
Jido.Actions.Scheduling.ScheduleCron,
Jido.Actions.Scheduling.ScheduleSignal,
Jido.Actions.Scheduling.ScheduleTimeout,
Jido.Actions.Status,
Jido.Actions.Status.MarkCompleted,
Jido.Actions.Status.MarkFailed,
Jido.Actions.Status.MarkIdle,
Jido.Actions.Status.MarkWorking,
Jido.Actions.Status.SetStatus
],
Sensors: [
Jido.Sensor,
Jido.Sensor.Runtime,
Jido.Sensor.Spec,
Jido.Sensors.Heartbeat,
Jido.Sensors.Bus
],
Thread: [
Jido.Thread,
Jido.Thread.Agent,
Jido.Thread.Entry,
Jido.Thread.Plugin,
Jido.Thread.Store,
Jido.Thread.Store.Adapters.InMemory,
Jido.Thread.Store.Adapters.JournalBacked
],
Memory: [
Jido.Memory,
Jido.Memory.Agent,
Jido.Memory.Plugin,
Jido.Memory.Space
],
Storage: [
Jido.Storage,
Jido.Storage.ETS,
Jido.Storage.File,
Jido.Storage.Redis,
Jido.Persist,
Jido.Agent.InstanceManager,
Jido.Agent.Persistence,
Jido.Agent.Store,
Jido.Agent.Store.ETS,
Jido.Agent.Store.File
],
Observability: [
Jido.Observe,
Jido.Observe.Config,
Jido.Observe.Log,
Jido.Observe.Tracer,
Jido.Observe.NoopTracer,
Jido.Observe.SpanCtx,
Jido.Debug,
Jido.Telemetry,
Jido.Telemetry.Config,
Jido.Telemetry.Formatter,
Jido.Tracing.Context,
Jido.Tracing.Trace
],
Utilities: [
Jido.Discovery,
Jido.Error,
Jido.Scheduler,
Jido.Util,
Jido.Agent.WorkerPool
],
Exceptions: [
Jido.Error.CompensationError,
Jido.Error.ExecutionError,
Jido.Error.InternalError,
Jido.Error.RoutingError,
Jido.Error.TimeoutError,
Jido.Error.ValidationError
]
]
]
end
defp package do
[
files: ["lib", "mix.exs", "README.md", "LICENSE", "usage-rules.md"],
maintainers: ["Mike Hostetler"],
licenses: ["Apache-2.0"],
links: %{
"Documentation" => "https://hexdocs.pm/jido",
"GitHub" => "https://github.com/agentjido/jido",
"Website" => "https://jido.run",
"Discord" => "https://jido.run/discord",
"Changelog" => "https://github.com/agentjido/jido/blob/main/CHANGELOG.md"
}
]
end
defp deps do
[
# Jido Ecosystem
{:jido_action, "~> 2.3"},
{:jido_signal, "~> 2.2"},
# Jido Deps
{:nimble_options, "~> 1.1"},
{:splode, "~> 0.3.0"},
{:telemetry, "~> 1.3"},
{:poolboy, "~> 1.5"},
{:telemetry_metrics, "~> 1.1"},
{:crontab, "~> 1.2"},
{:time_zone_info, "~> 0.7"},
# Development & Test Dependencies
{:git_ops, "~> 2.9", only: :dev, runtime: false},
{:git_hooks, "~> 0.8", only: [:dev, :test], runtime: false},
{:credo, "~> 1.7", only: [:dev, :test]},
{:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false},
{:doctor, "~> 0.21", only: [:dev, :test], runtime: false},
{:ex_doc, "~> 0.34", only: :dev, runtime: false},
{:excoveralls, "~> 0.18.3", only: [:dev, :test]},
{:mix_test_watch, "~> 1.0", only: [:dev, :test], runtime: false},
# Code generation
{:igniter, "~> 0.7", optional: true}
]
end
defp aliases do
[
# Helper to run tests with trace when needed
# test: "test --trace --exclude flaky",
test: "test --exclude flaky",
# Helper to run docs
docs: "docs --open",
# Run to check the quality of your code
q: ["quality"],
quality: [
"format --check-formatted",
"compile --warnings-as-errors",
"credo --min-priority higher",
"dialyzer"
]
]
end
end