Skip to main content
Prerequisites (recommended):
  • Docker + Docker Compose
  • Python 3.9+ for the SDK and gym packages
  • Python 3.14+ for the platform API
  • Node.js 24.x with pnpm for the web apps and docs
This page is for contributors and self-hosters running Agent Sentinel locally.

​
Platform API local dev

Agent Sentinel’s platform lives in apps/platform/ and runs with Docker Compose.
  1. Create apps/platform/.env (minimum required keys):
  1. Start the stack:
  • API: http://localhost:8000
  • OpenAPI/Swagger UI: http://localhost:8000/docs

​
Web console

The operator console lives in apps/console-sentinel/.

​
Public web app

The public web app lives in apps/web/.

​
Docs (Mintlify)

1

Install the Mintlify CLI

2

Preview locally

Navigate to docs/ and start the preview server:
A local preview of your documentation will be available at http://localhost:3000.

​
Troubleshooting

  • Ensure apps/platform/.env is set (especially SECRET_KEY, FIRST_SUPERUSER, FIRST_SUPERUSER_PASSWORD).
  • Use POST /api/v1/login/access-token to get a JWT, then call protected endpoints with Authorization: Bearer <jwt>.
Try updating the CLI and restarting: