Skip to main content
Go from pip install to an agent that replies on a messaging channel and runs code in a sandbox — with a health check that proves every piece is up.
The user mentions the bot in a chat; the gateway routes the message to the agent, the agent replies on the same channel, and any code it runs stays inside the sandbox.

Quick Start

1

Install

praisonai brings the gateway, channels, and Claw UI. The sandbox extra adds the Docker backend.
2

Export secrets (shell only)

Never paste a token into gateway.yaml, a notebook, or a commit. Reference it with ${VAR} — see Secret References.
3

Write gateway.yaml

4

Start the gateway

Preflight validates your model key and channel token before binding the port.
5

Send a message

Mention the bot in your chat. You should get a reply within a few seconds.
6

Run a sandboxed command

7

Verify everything


Step Matrix


Health Check

Existing commands already probe each service:
The gateway and the browser bridge both default to port 8765. When running both, start the bridge on another port: praisonai browser start --port 8766.
For CI or a single pass/fail signal, this snippet probes all three endpoints without reading any secret:
Expected output:

Environment Variables


Troubleshooting

The gateway is not running or is bound to another port. Run praisonai gateway status and check the PID lock and port lines.
/health shows the channel running but no reply arrives. Check the token’s scopes / event subscriptions and make sure only one process polls the token. See Troubleshoot Gateway.
The sandbox step is blocked even though the gateway is green. Start Docker, or pick another backend from Sandbox Backends. Never mark the step as passed when the sandbox failed.
The bridge is up but no extension is attached. Open the extension side panel and re-run praisonai browser doctor server --port 8766.

Best Practices

Commit gateway.yaml with ${VAR} placeholders only. For production, move to file or exec secret sources — see Secret References.
127.0.0.1 keeps the admin API local. Set GATEWAY_AUTH_TOKEN before binding to 0.0.0.0.
Run the check after every gateway upgrade or token rotation so regressions show up immediately.
For Kubernetes, pass the auth token through chart values — see Helm Chart.

Gateway CLI

Start, stop, and inspect the gateway

Sandbox

Isolated code execution for agents

Secret References

Keep tokens out of config files

Troubleshoot Gateway

Fix common gateway issues