Quickstart
Before you start
Section titled “Before you start”We currrently support:
- MacOS or Linux
- Claude Code, Cursor, Codex, and Copilot CLI
We’re happy to support other platforms and agents upon request. Contact us!
1. Set your password
Section titled “1. Set your password”Open the email “You’ve been added to Viewport” and click Set your password. It automatically signs you in. Later, sign in at app.tryviewport.ai.
Invitations, sign-in and organizations: Your team.
2. Install the CLI
Section titled “2. Install the CLI”curl -fsSL https://tryviewport.ai/install.sh | shThe installer also adds the /viewport command to every coding agent it finds.
Requirements, what the installer writes, PATH, uninstall: Install the CLI.
3. Sign in the CLI
Section titled “3. Sign in the CLI”viewport loginYour browser opens. Check the code matches your terminal and click Authorize.
Tokens and signing a machine out: Install the CLI, Sign in.
4. Work on a branch with your agent
Section titled “4. Work on a branch with your agent”Open a new session in your agent, create a branch and let the agent make the change. The conversation is recorded on your machine and stays there until you run a review.
What each agent gets and what is recorded: Connect your coding agent.
5. Start the review
Section titled “5. Start the review”/viewport prType it in your agent, or run viewport pr in a terminal. The CLI prints the review’s link. Nothing in your repository changes.
What is sent, versions, Rerun: Run a review. The errors you may see: Troubleshooting.
6. Read the review
Section titled “6. Read the review”Open the link. Start with the Signals tab: the decisions made during the work, strongest first. The Changes tab has the whole diff.
Home, a repo and the four tabs: Read a review. Threads, mentions and reviewers: Comment and ask.