seeknal report-server¶
Self-hosted server for publishing and sharing Evidence.dev reports generated by seeknal ask report. Each published report gets a unique shareable URL.
Synopsis¶
Description¶
The report server hosts HTML reports built by the ask agent's generate_report tool. After building a report, you can publish it to the server (either from the chat TUI menu or via the publish_to_seeknal_report agent tool) and share the URL with your team.
Prerequisites¶
Options¶
| Flag | Type | Default | Description |
|---|---|---|---|
--host |
TEXT | 127.0.0.1 |
Host to bind to |
--port |
INT | 8787 |
Port to listen on |
--data-dir |
PATH | None | Directory for storing published reports |
Examples¶
# Start locally
seeknal report-server start
# Custom port and host
seeknal report-server start --host 0.0.0.0 --port 9000
# Specify data directory
seeknal report-server start --data-dir /var/seeknal/reports
Publishing Reports¶
Reports can be published to the server in two ways:
1. From the chat TUI menu — After generate_report builds a dashboard, the interactive menu offers "Publish to Seeknal Report Server".
2. Via the agent tool — Ask the agent: "publish this report to the report server". It calls publish_to_seeknal_report automatically.
Both methods require these environment variables in your project's .env:
Authentication¶
The server supports two auth modes controlled by the SEEKNAL_REPORT_SERVER_AUTH_MODE env var:
| Mode | Description |
|---|---|
token (default) |
Requires SEEKNAL_REPORT_SERVER_KEYS — comma-separated list of valid tokens |
open |
No authentication (development only) |
Server-side configuration¶
# Token-based auth (production)
export SEEKNAL_REPORT_SERVER_AUTH_MODE=token
export SEEKNAL_REPORT_SERVER_KEYS=my-secret-key-1,my-secret-key-2
# Open mode (development only)
export SEEKNAL_REPORT_SERVER_AUTH_MODE=open
Published Report URLs¶
Each published report gets a unique slug:
A ledger of all published reports is maintained in the project at target/reports/.seeknal-report-ledger.json.
See Also¶
- seeknal ask — Generate reports with the AI agent
- Report Exposures Tutorial — Build deterministic reports
- seeknal gateway — HTTP API gateway