Documentation
Product, API, integrations, deployment, and CLI reference
Architecture
System layout, runtime model, auth/tenancy, mutation safety, and integration pipeline.
- Nuxt 3 + Nitro fullstack structure
- Workspace isolation and RBAC checks
- Session-cookie auth, scoped API tokens, and provider-token storage
API
Core endpoint map for auth, orgs, boards, cards, integrations, workspace sessions, and admin.
- Auth + membership-guarded operations
- Board/card lifecycle routes
- Workspace sessions, run history/control, notifications, and realtime
Integrations
GitHub, Linear, Notion, Jira, Trello, Slack, and Zergchat integration flows.
- OAuth connect/status/disconnect routes and webhooks
- Manual token fallback modes
- Provider env var and token-encryption matrix
Deployment
Fly.io deployment, secret setup, health checks, and rollback baseline.
- Required secrets, optional providers, and cron/ZTC settings
- Post-deploy verification checklist
- Migration and rollback notes
CLI
Go + Bubble Tea CLI (`zb`) for login, boards/cards, imports, and workspace run history.
- Interactive TUI mode
- Scriptable non-interactive commands
- Config stored at ~/.zergboard/zb.json
Current limits
Intentional omissions in the current hardened surface.
- No workspace run launch/retry API or CLI command
- No native mobile push registration endpoint
- Notifications are in-app, email, Slack, or Zergchat
Command quickstart
Build and run the Go CLI locally
cd cli/zb
go mod tidy
go build -o zb
./zb login --email you@example.com --password '...'
./zb orgs
./zb boards
./zb workspace-runs list --session-id <session-id>Source docs in repo
Canonical markdown docs live under the repository docs/ directory
- docs/README.md
- docs/architecture.md
- docs/api.md
- docs/integrations.md
- docs/deployment.md
- docs/cli.md