Run a review
A review starts when you send a branch and the conversation behind it to Viewport.
Start a review
Section titled “Start a review”In your coding agent, with the branch checked out:
/viewport prOr in a terminal, inside the repository:
viewport pr [source] [target]sourceis the branch to review. It defaults to the branch you have checked out.targetis the branch it will merge into. It defaults to your remote’s default branch (origin/HEAD), elsemain, elsemaster.
To review a branch against something other than the default, name both: viewport pr my-feature release-2.
The CLI prints the review’s link when it is done. The first viewport pr on a branch starts the pipeline; the review page shows In progress until it finishes and Review ready after.
What is sent
Section titled “What is sent”Two things go to Viewport:
- Commits. The CLI runs
git pushto Viewport’s own git server with three commits: your branch’s head, the target branch’s tip and the commit where the two diverged (the merge base). Git sends those commits and the history behind them that Viewport does not already have. No other branches or tags are pushed. - The conversation. Every recorded agent turn on the source branch since it was created, from any of your agents, plus the turns on the target branch right before you created the branch, which is usually where the planning happened before
git checkout -b.
Viewport needs both. A branch with no recorded conversation is refused; see the errors below.
What is never done
Section titled “What is never done”- Nothing in your repository changes. The CLI adds no git remote, writes no refs and edits no files.
- Nothing goes to GitHub or any other forge, and no pull request is opened or read.
- Viewport never comments on your code or pushes to your branch.
Push again
Section titled “Push again”Run viewport pr again on the same branch after new commits, and Viewport records a new version of the review (v2, v3 and so on) in Activity. A new version does not start the pipeline, so the signals and the description stay as they were. If nothing changed since the last push, nothing is recorded.
Comment threads follow their lines into the new version. If the line a thread was on was replaced, the thread stays in Activity with a note. In Changes, Compare from and Compare to let you look at the diff between any two versions.
To have the pipeline read the latest version, click Rerun in the review page’s header. It asks “Rerun the pipeline?”: the run uses the latest version and replaces the current signals, and comment threads are kept. A rerun counts as a review against your team’s quota; see Your team.
Errors you may see
Section titled “Errors you may see”| Message | What to do |
|---|---|
not logged in to <server>, run viewport login |
Run viewport login. |
not inside a git repository |
Run it from inside the repository. |
branch not found: <name> |
Check the branch name, or fetch the target branch. |
<branch> is both the source and the target |
Check out the branch to review, or name it. |
no agent conversation was captured on branch <name> |
Make sure capture is on and the work happened on this branch. |
Troubleshooting has more on each.