Skip to main content

Guardrails Demo (2 minutes)

:::info Recommended first run This is the fastest way to see Cordum's governance catch something real. After this, the Minimal Stack Smoke Test confirms every service is individually reachable, and the full Tutorials go deeper with multi-step workflows. :::

This demo shows:

  • Safety Kernel blocking a dangerous request
  • A remediation suggestion
  • An approval gate for risky work

If you want a local cordumctl binary:

make build SERVICE=cordumctl

Prereqs​

  • Docker + Docker Compose
  • curl + jq
  • Go (for the demo worker)

1) Start the stack​

go run ./cmd/cordumctl up
# or:
./bin/cordumctl up
# or:
docker compose up -d

2) Start the demo worker​

cd examples/demo-guardrails/worker
REDIS_URL=${REDIS_URL:-redis://:${REDIS_PASSWORD}@localhost:6379} \
NATS_URL=${NATS_URL:-nats://localhost:4222} \
go run .

3) Install the demo pack​

./bin/cordumctl pack install --upgrade ./examples/demo-guardrails

If you didn't build the binary, use:

go run ./cmd/cordumctl pack install --upgrade ./examples/demo-guardrails

The demo script also installs the pack if it's missing.

4) Run the demo script​

CORDUM_API_KEY=${CORDUM_API_KEY:?set CORDUM_API_KEY} \
CORDUM_TENANT_ID=${CORDUM_TENANT_ID:-default} \
CORDUM_ORG_ID=${CORDUM_ORG_ID:-default} \
./tools/scripts/demo_guardrails.sh

If your gateway is not on localhost (for example, running inside a Docker network), set the API base and gateway:

CORDUM_API_BASE=http://cordum-api-gateway:8081 \
CORDUM_GATEWAY=http://cordum-api-gateway:8081 \
CORDUM_API_KEY=${CORDUM_API_KEY:?set CORDUM_API_KEY} \
CORDUM_TENANT_ID=${CORDUM_TENANT_ID:-default} \
CORDUM_ORG_ID=${CORDUM_ORG_ID:-default} \
./tools/scripts/demo_guardrails.sh

One-command runner (starts the worker + demo):

./tools/scripts/demo_guardrails_run.sh

Note: the first run may take a bit while Go downloads modules and the worker registers a heartbeat. The runner waits for a worker in the demo-guardrails pool specifically, so unrelated worker heartbeats do not trigger a false ready state.

Record a GIF​

Option A: VHS (terminal GIF recorder)

# macOS: brew install vhs
# Linux: https://github.com/charmbracelet/vhs
vhs ./tools/scripts/demo_guardrails.tape

Option B: GUI recorder

  • macOS: Kap
  • Linux: Peek
  • Windows: ShareX

Save the output as docs/assets/guardrails-demo.gif.