Development Setup
Clone the repository
git clone <repo-url> sentinel
cd sentinelInstall Node.js dependencies
npm installStart the dev server
npm run devDashboard will be at http://localhost:5001. A Welcome Wizard walks you through first-run setup.
Set up the Python side (LiteLLM proxy)
cd litellm
python3.12 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
cd ..Enable RBAC for development (optional)
Set RBAC_ENABLED=true in .env to enable operator authentication during development.
Key Directories
| Directory | Purpose |
|---|---|
src/lib/shield/ | Shield engine and rule definitions |
src/lib/rbac/ | RBAC middleware and permissions |
src/app/api/ | All API route handlers |
src/app/api/auth/ | Authentication endpoints |
src/app/api/config/operators/ | Operator management |
src/mcp/ | MCP server |
litellm/ | LiteLLM proxy config and ClawNex logger |
docs/ | Enterprise documentation suite |
Key Documentation
| Doc | When to Read |
|---|---|
docs/02-high-level-architecture.md | First — 10-minute system overview |
docs/18-developer-manual.md | Deep dive into every subsystem |
docs/19-api-mcp-integration-guide.md | Before touching the public API or MCP server |
docs/11-security-architecture.md | Before touching the shield engine or break-glass |
Building for Production
npm run buildThis must succeed before submitting a pull request.