Automate with the CLI

The CLI emits structured output (JSON, YAML) for scripting. Combined with jq and --quiet mode, it composes naturally with shell pipelines.

For a command reference, see CLI.

Capture IDs

AGENT_ID=$(everruns agents create \
  --name "assistant" \
  --system-prompt "You are a helpful assistant." \
  -o json | jq -r '.id')

SESSION_ID=$(everruns sessions create --agent "$AGENT_ID" -o json | jq -r '.id')

everruns chat "What time is it?" --session "$SESSION_ID"

Quiet mode

--quiet suppresses headers and tables, printing only the essential identifier:

everruns agents create -f agent.toml --quiet
# Output: agt_550e8400e29b41d4a716446655440000

Useful inside $(...) substitution when JSON parsing is overkill.

Filter listings

# Active agents only
everruns agents list --output json | jq '.data[] | select(.status == "active")'

# Just the names of agents tagged "production"
everruns agents list -o json \
  | jq -r '.data[] | select(.tags[]? == "production") | .name'

# Agents created in the last 24h
everruns agents list -o json \
  | jq --arg cutoff "$(date -u -d '24 hours ago' +%FT%TZ)" \
       '.data[] | select(.created_at > $cutoff)'

Configure the API URL

# Per-command
everruns --api-url http://localhost:9300/api agents list

# For the whole shell
export EVERRUNS_API_URL=http://localhost:9300/api
export EVERRUNS_API_KEY=dev

In CI, set both via secrets and the CLI will pick them up automatically.

Drive sessions from a file-defined agent

cat > agent.md <<'EOF'
---
name: "code-reviewer"
capabilities:
  - ref: current_time
  - ref: filesystem
    config:
      allowed_paths: ["/workspace"]
tags: [development]
---
You are an expert code reviewer.

When reviewing code:
1. Check for bugs and edge cases
2. Suggest performance improvements
3. Ensure code follows best practices
EOF

AGENT_ID=$(everruns agents create -f agent.md -o json | jq -r '.id')
SESSION_ID=$(everruns sessions create --agent "$AGENT_ID" -o json | jq -r '.id')

everruns chat "Review the diff at HEAD~1..HEAD" --session "$SESSION_ID"

Send-and-exit (no streaming)

--no-stream queues the message and returns immediately. Useful when a downstream system polls for results.

everruns chat "Process the queue" --session "$SESSION_ID" --no-stream