Viewport docs
A canonical 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 an agent, decide from your phone. Five minutes to your first approval from a coffee shop.
- I’m setting up my team
Invite teammates, share workflows, route approvals to the right people, ship Slack notifications.
- I want to self-hostBeta
Run your own relay so daemon traffic stays in your network. Full-stack on-prem in beta.
Concepts
How Viewport thinks about the work agents do. Sessions, plans, decisions, context, workflows, and the tenant model.
- Sessions
One agent run on one machine. Owned by the daemon, never persisted server-side.
- 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.
- Context Vault
HPKE-encrypted signed event log. 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’s stored, what isn’t, what the relay can see. The auditable version of the marketing pitch.
Reference
The shape of the things teams ship: the CLI, the spec, the wire protocol, and the env-var surface.
- CLI
Every vpd verb grouped by surface: lifecycle, pairing, directories, sessions, workflows, context, more.
- 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.