Skip to content

agentjido/jido_run

Repository files navigation

Jido Workbench

Jido Workbench is a Phoenix LiveView app for Jido ecosystem documentation, examples, and internal learning content.

This repository is an internal docs/workbench app, not the public SDK source repository for jido or jido_ai.

Quick Start

Prerequisites:

  • Elixir and Erlang (see mix.exs)
  • PostgreSQL running locally
git clone git@github.com:agentjido/agentjido_xyz.git
cd agentjido_xyz
cp .env.example .env
mix setup
mix phx.server

Open http://localhost:4000.

Development Auth

Self-service signup is intentionally disabled.

Bootstrap a local admin account:

ADMIN_EMAIL=you@example.com ADMIN_PASSWORD='at-least-12-chars' mix run priv/repo/seeds.exs

Notes:

  • ADMIN_PASSWORD is optional. If omitted, log in via magic link.
  • With the local mail adapter, open http://localhost:4000/dev/mailbox to get login links.
  • mix setup already runs seeds, so rerun the seed command any time you want to update/bootstrap your dev account.

Common Commands

mix test
mix format
mix credo
mix quality

Content Layout

  • priv/content_plan/** contains content briefs and planning docs.
  • priv/pages/** contains docs pages served by the site.
  • priv/blog/**, priv/examples/**, and priv/ecosystem/** contain other published content.

For content updates, prefer updating the relevant brief in priv/content_plan/** and then syncing the corresponding page in priv/pages/**. Direct page edits are still fine for quick fixes.

Link Audit

Run the site link audit:

mix site.link_audit --include-heex

Useful variants:

# Include external URL checks (slower)
mix site.link_audit --include-heex --check-external

# Temporarily allow known hidden route prefixes
mix site.link_audit --include-heex --allow-prefix /training

The audit writes tmp/link_audit_report.md by default and exits non-zero on blocking issues.

Contributing

See CONTRIBUTING.md.

About

Website, Docs and Examples for the Jido Ecosystem - PR's welcome

Resources

Contributing

Stars

Watchers

Forks