$git clone https://github.com/cordum-io/cordum---
| 1 | <p align="center"> |
| 2 | <img src="dashboard/public/logo.png" alt="Cordum" width="200"/> |
| 3 | </p> |
| 4 | |
| 5 | <h1 align="center">Cordum</h1> |
| 6 | |
| 7 | <p align="center"> |
| 8 | <a href="https://artifacthub.io/packages/helm/cordum/cordum"><img src="https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/cordum" alt="Artifact Hub" /></a> |
| 9 | </p> |
| 10 | |
| 11 | <p align="center"> |
| 12 | <strong>Know What Your AI Agents Are Doing. Before They Do It.</strong><br/> |
| 13 | The Source-Available <strong>Agent Control Plane</strong> for Governance, Safety, and Trust.<br/> |
| 14 | <em>Includes <strong>Cordum Edge</strong> — a Compliance Firewall for Claude Code and other local AI-agent actions.</em> |
| 15 | </p> |
| 16 | |
| 17 | <p align="center"> |
| 18 | <a href="https://github.com/cordum-io/cordum/stargazers"><img src="https://img.shields.io/github/stars/cordum-io/cordum?style=social" alt="Stars"/></a> |
| 19 | <a href="https://github.com/cordum-io/cordum/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-BUSL--1.1-blue" alt="License"/></a> |
| 20 | <a href="https://github.com/cordum-io/cordum/releases"><img src="https://img.shields.io/github/v/release/cordum-io/cordum?sort=semver" alt="Release"/></a> |
| 21 | <a href="https://github.com/cordum-io/cordum/actions/workflows/ci.yml"><img src="https://github.com/cordum-io/cordum/actions/workflows/ci.yml/badge.svg" alt="CI"/></a> |
| 22 | <a href="https://goreportcard.com/report/github.com/cordum-io/cordum"><img src="https://goreportcard.com/badge/github.com/cordum-io/cordum" alt="Go Report Card"/></a> |
| 23 | <a href="https://discord.gg/nvHzPCcWWt"><img src="https://img.shields.io/badge/discord-join-5865F2?logo=discord&logoColor=white" alt="Discord"/></a> |
| 24 | <a href="https://github.com/cordum-io/cap"><img src="https://img.shields.io/badge/protocol-CAP%20v2-green" alt="CAP Protocol"/></a> |
| 25 | </p> |
| 26 | |
| 27 | <p align="center"> |
| 28 | <a href="https://discord.gg/nvHzPCcWWt">Discord</a> · <a href="https://github.com/cordum-io/cordum/discussions">Discussions</a> · <a href="docs/">Docs</a> |
| 29 | </p> |
| 30 | |
| 31 | --- |
| 32 | |
| 33 | ## Quickstart |
| 34 | |
| 35 | ### First Time? |
| 36 | |
| 37 | | Goal | Path | |
| 38 | |------|------| |
| 39 | | **Just want to try it?** | `./tools/scripts/quickstart.sh` — one-command install from source (Option A below) | |
| 40 | | **Run the full stack from pre-built images?** | `docker compose pull && docker compose up -d` (Option B below) | |
| 41 | | **Developing Cordum?** | See [Development](#development) | |
| 42 | |
| 43 | ### Option A: Install from source |
| 44 | |
| 45 | One command stands up the full stack — API gateway, scheduler, safety |
| 46 | kernel, workflow engine, context engine, dashboard, NATS, and |
| 47 | TLS-secured Redis — with auto-generated secrets, auto-provisioned |
| 48 | certificates, and a post-deploy smoke test that exercises a real |
| 49 | approval workflow: |
| 50 | |
| 51 | ```bash |
| 52 | git clone https://github.com/cordum-io/cordum.git |
| 53 | cd cordum |
| 54 | ./tools/scripts/quickstart.sh |
| 55 | ``` |
| 56 | |
| 57 | **Prerequisites:** Docker Desktop v4+ (or Engine v20.10+ with Compose v2, |
| 58 | ≥ 4 GB RAM allocated), Go 1.26.3+ (for first-run cert generation), and |
| 59 | `curl`. On Windows use MSYS2 / Git Bash / WSL. |
| 60 | |
| 61 | **What you get at the end:** |
| 62 | - Dashboard at http://localhost:8082 — log in as `admin` / `ChangeMe123!` |
| 63 | (the default dev password, also saved to `.env` as `CORDUM_ADMIN_PASSWORD`; |
| 64 | change it before exposing the stack). |
| 65 | - Gateway at http://localhost:8081 with a generated `CORDUM_API_KEY` in |
| 66 | `.env`. |
| 67 | - TLS CA, server, and client keypairs under `./certs/`. |
| 68 | - A working approval-gate workflow proven by the built-in |
| 69 | `platform_smoke.sh` run. |
| 70 | |
| 71 | Full walkthrough, platform notes, and troubleshooting: |
| 72 | [docs/quickstart.md](docs/quickstart.md). |
| 73 | |
| 74 | ### Option B: Run the published images |
| 75 | |
| 76 | **Prerequisites:** Docker Desktop v4+ or Docker Engine v20.10+ with the |
| 77 | Compose v2 plugin (≥ 4 GB RAM allocated), `jq` (recommended, for parsing |
| 78 | API responses), and Go 1.26.3+ (for one-time local cert generation — |
| 79 | `docker compose` mounts `./certs` but does not create it). |
| 80 | |
| 81 | ```bash |
| 82 | git clone https://github.com/cordum-io/cordum.git |
| 83 | cd cordum |
| 84 | go run ./cmd/cordumctl generate-certs # writes ./certs/{ca,server,client} |
| 85 | export CORDUM_API_KEY=$(openssl rand -hex 32) |
| 86 | export REDIS_PASSWORD=$(openss |