Quick Start

Before you start

Sign up at peak.inc.
Be an owner of your GitHub organization.
Connect your GitHub organization in Settings.

Terminal setup

Run this in your repository folder.

npx -y @peakinc/init@latest

Coding agent setup

Install the Peak skill once. Then ask your agent to set up Peak.

npx skills add PeakInc/skills --skill peak-setup

Or paste this into your coding agent.

Set up Peak in this repository. Run npx -y @peakinc/init@latest --yes --json --no-browser. Show me the sign in link it prints. Wait until I approve it. Then give me the pull request link.

Peak agent setup

Run this in your repository folder.

npx -y @peakinc/wizard@latest

Manual setup

Change the runner in your workflow file.

.github/workflows/ci.yml

runs-on: ubuntu-latest
runs-on: peak-ubuntu-24.04-4

​Before you start

​Terminal setup

​Coding agent setup

​Peak agent setup

​Manual setup

Before you start

Terminal setup

Coding agent setup

Peak agent setup

Manual setup