Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.esheria.ai/llms.txt

Use this file to discover all available pages before exploring further.

The esheria CLI is a thin client over the public Regulatory Pack API. It does not read Postgres, S3, pipeline artifacts, or internal evidence folders directly.

​
Install

pip install esheria

​
Configure

export ESHERIA_API_BASE_URL="https://reg-api.esheria.co.ke"
export ESHERIA_API_KEY="YOUR_ESHERIA_API_KEY"
export ESHERIA_DEFAULT_PACK_ID="KE-DATA-PROTECTION"
export ESHERIA_TIMEOUT_SECONDS="30"
export ESHERIA_RETRY_COUNT="2"

​
Smoke Test

esheria health --format json
esheria ready --format json
esheria packs list --format json
esheria packs inspect KE-DATA-PROTECTION --format json
esheria obligations list KE-DATA-PROTECTION --query breach --limit 3 --format json

​
Core Commands

WorkflowCommand
Healthesheria health
Readinessesheria ready
Diagnosticsesheria doctor --pack KE-DATA-PROTECTION
Pack discoveryesheria packs list
Pack inspectionesheria packs inspect KE-DATA-PROTECTION
Pack exportesheria packs export KE-DATA-PROTECTION --out pack.json
Obligationsesheria obligations list KE-DATA-PROTECTION --limit 25
Applicabilityesheria applicability check KE-DATA-PROTECTION --role data_controller --activity personal_data_processing
Claim verificationesheria claims verify --pack KE-DATA-PROTECTION "..."
Filing calendaresheria calendar list KE-DATA-PROTECTION
Evidence registeresheria evidence list KE-DATA-PROTECTION
Citation contextesheria citations get KE-DATA-PROTECTION --citation-id CITATION_ID
Relationshipsesheria relationships list KE-DATA-PROTECTION
Graph queryesheria graph query --pack KE-DATA-PROTECTION

​
Output Formats

Leaf commands support: 
--format table
--format json
--format yaml
--format ndjson
--raw
--envelope
Use --envelope when you need the full API envelope. Use --raw when you want the returned payload without table formatting.

​
Examples

​
List Packs

esheria packs list --jurisdiction KE --limit 10 --format json

​
Check Applicability

esheria applicability check \
  KE-CORPORATE-REGISTRY-BRS \
  --role company \
  --activity beneficial_ownership_register_maintenance \
  --limit 5 \
  --format json

​
Verify A Claim

esheria claims verify \
  --pack KE-CORPORATE-REGISTRY-BRS \
  "A company shall keep a register of beneficial owners." \
  --format json

​
Troubleshooting

SymptomLikely causeFix
esheria opens SSH or another programShell alias shadows the installed commandRun type -a esheria, then remove or rename the alias
Invalid API keyMissing or wrong ESHERIA_API_KEYRe-export the key and retry esheria packs list
Request hangsWrong base URL or network issueTest curl "$ESHERIA_API_BASE_URL/healthz"
unsupported_capabilityThe pack does not support that workflowUse generic pack endpoints or choose another pack
Repository-local wrappers remain available as bin/esheria and bin/esheria-mcp for contributors working from a checkout.