Viewport daemon, relay, and hosted runtime are available in alpha. Surfaces may change.
VIEWPORT
Start

Pick your path

Three audiences, three roads. Pick the one that matches what you're trying to accomplish today.

Same docs, three audiences. The fastest read for you depends on which one you are.

I'm a developer with a laptop

You write code. Sometimes an agent does. You want your local and cloud agent work governed by the same team policy, keys, context, and receipts.

Start here:

  1. CLI setup reference · install vpd, choose worker or personal monitor mode, and verify the daemon.
  2. Add a repo · tell the daemon which directories to watch.
  3. Decide from anywhere · understand the inbox and review flow across web and Slack.

Then, per supported agent:

I'm rolling Viewport out to my team

You're not just running agents. Your team is. You want a shared inbox, audit log, and approval routing.

Start here:

  1. Self-serve first run · sign up, install vpd, pair the worker, connect Slack/GitHub, and prove the first run.
  2. Create an organization.
  3. Set up teams · create the first team and link its Git Resource for .viewport/ evidence.
  4. Invite teammates · add reviewers into the team scope.
  5. Share resources · workflows, plans, artifacts, and Git evidence.
  6. Approval policies · who decides what, and how timeouts escalate.

Plus:

I want to self-host

You can't or won't run on hosted infrastructure. The relay can be self-hosted today; the control plane cannot be self-hosted without a pilot.

Start here:

  1. Self-host overview · what you can deploy today, what's still hosted.
  2. Deploy the relay · one Docker command, plus DNS and TLS.
  3. Backplane modes · multi-relay topologies (server vs Redis).
  4. Monitor and operate · /state, /metrics, /logs, alerting recipes.
  5. Security posture · threat model, what the relay can and cannot see.
  6. On-prem status · what is available, what is alpha, and what is not available yet.

Common to all paths

Whoever you are, you'll hit these eventually:

  • Concepts · automations, sessions, plans, inbox, vault. The mental model.
  • CLI reference · every vpd subcommand with real flags.
  • Workflow YAML · the spec for .viewport/ policy and route files.
  • API · REST + WebSocket protocol.
  • Troubleshooting · the top failure modes and recovery.

Mental model

Six questions cover the customer-facing workflow model.

Concepts

The durable concepts behind Viewport: automations, runners, context, approvals, actions, and receipts.

On this page

I'm a developer with a laptopI'm rolling Viewport out to my teamI want to self-hostCommon to all paths