Skip to main content

​
Before you start

  • Install Node.js 22.13 or newer and Git.
  • Open your repository folder.
  • Check that your GitHub remote is named origin.
  • Check that you can push a branch.
  • Install and sign in to the GitHub CLI to open pull requests from your terminal.
  • Complete GitHub setup.

​
Preview changes

Run a dry run to review the plan without signing in or creating a branch.
Review changes against the remote default branch. Commit and push any work you want included in that base first.

​
Open a pull request

Open the sign-in link if asked. Match the code in your terminal with the code in your browser. Approve access. Review the diff and approve the change. Open the pull request link. If the GitHub CLI is missing or fails, open the compare link to create the pull request. Review skipped jobs before you merge.

​
Choose setup flags

Add these flags to either setup command. Approve sign-in in your browser even when you use the flag below.

​
Connect a coding agent

Run setup with JSON events and a sign-in link.
Relay the sign-in URL to the person who can approve access. Wait for approval, then read the pull request URL from the output. To answer each question yourself, omit the automatic-answer flag. Read the question ID from each event. Send your answer on stdin.
Check the exit code after setup.

​
Undo setup

Switch away from the setup branch first. Run the undo command from the same repository.
For Peak agent setup, use its undo command.
Follow the printed command to delete a pushed branch if needed. Close an open pull request on GitHub if needed. To undo a merged change, revert its commit on GitHub. Do not use setup undo to revert a merge.

​
Use the Peak CLI

Sign in and check your workspace.
Revoke the active CLI token when you no longer need it.
Use API access for token scopes and unattended agents.