Viewport docs
A working reference for the Viewport runtime, daemon, and control plane. For developers running coding agents, for teams rolling them out, and for anyone self-hosting the stack.
The daemon and relay are open source on github.com/viewportai/viewport.
Start
Pick the path that matches what you’re trying to do today.
- I’m a developer
Pair your machine, run agents under team policy, and inspect decisions from the web app or Slack.
- I’m setting up my team
Invite teammates, share workflows, route approvals to the right people, and send Slack notifications.
- I want to self-hostAlpha
Run your own relay so daemon traffic stays in your network. Full-stack on-prem is still early.
Concepts
How Viewport thinks about the work agents do. Sessions, plans, decisions, context, workflows, and the tenant model.
- Sessions
The collaborative workspace for governed agent work: routing, policy, context, review, and receipts.
- Plans
Reviewable artifacts with revisions, threaded feedback, and an approval state machine.
- Inbox
Plan review, approval gate, context candidate. One queue, routed by who has access.
- Team Context
Team-owned memory with HPKE-encrypted signed events. The platform stores only ciphertext.
- Workflows
Repo-local YAML validated against a JSON Schema. Plugin SDK for custom node types.
- Organizations and teams
The tenant model. Workspaces are the wall. Teams are org-local groups. Users are global with multi-org membership.
- Machines and pairing
Pair, bind, stream. Per-org daemon identity. Session pinning. Revocation.
- Trust and privacy
What is stored, what is not stored, and what the relay can see.
Security
What Viewport stores, what stays local, and where decryption happens. The auditable version of the privacy pitch.
- Security explained
The split between the control plane and the trusted edge. What the platform sees, what it cannot.
- Team Context encryption
How repo-attached context is encrypted, synced, selected, and delivered to an agent session.
- Plans and encryption
How the encryption model applies to plans. What ships today, and the encrypted-plan direction.
- Sharing and revocation
Resource ACLs, key grants, teams, org admins, and revocation, end to end.
- Session relay decryption
How the browser renders live session plaintext without the relay or platform database storing the transcript.
Reference
The CLI, the repo config, the wire protocol, and the env vars.
- CLI
Every vpd command grouped by what it does: lifecycle, pairing, directories, sessions, workflows, and context.
- Workflow YAML
viewport-config-v1 and viewport.workflow/v1. JSON Schemas your team commits to a repo.
- API
Public REST endpoints and the daemon WebSocket protocol.
- Webhooks
Signed delivery, event schema, retry policy. Bridge inbox + audit to your own systems.
- Environment variables
Every env var the daemon, relay, and CLI accept. Defaults, scope, when to use each.
Operate
Run your own relay or troubleshoot the one we run for you.