---
title: Quick start
description: Install with the web assistant and verify one issue-to-PR workflow.
---
> ## Documentation Index
> Fetch the complete documentation index at: https://docs.page/vypdev/copilot/llms.txt
> Use this file to discover all available pages before exploring further.

Use this checklist if you already know your repository and runner choices. Follow [Set up with the web assistant](/setup-web) for the illustrated walkthrough.

## 1. Prepare

You need Node.js 24 or newer, `pnpm`, a working checkout on an attached Git branch, and permission to install workflows and configure the selected GitHub resources. Choose the account that will own the workflow PAT; a dedicated bot account is recommended. AI features also need a usable runtime/model and authentication on the runner.

## 2. Launch the local web assistant

```bash
pnpm add --global @vypdev/copilot
copilot --version
cd /path/to/your/repository
copilot setup --web
```

Enter the pairing code from the terminal, confirm the repository, and choose **This repository** and **Basic guided setup**. `copilot setup` without `--web` remains the terminal alternative; `copilot setup --web --dry-run` previews without setup changes.

## 3. Select and review

For the [first workflow](/first-workflow), enable Issues, Pull requests, Commits, the Documentation issue kind and Issue Forms. Enable the comment capabilities if you want `/copilot` commands. You can leave Projects, releases and hotfixes disabled until you need them.

Check your actual production/development branches and runners. The development branch must already exist. New setup offers PR approval assessment in `recommend` mode, which does not submit native approvals. Select `off` if you do not want assessment; choose `guarded` explicitly only after its [CI/coverage and branch-rule prerequisites](/pull-requests/guarded-approval) are proven.

Follow the guided GitHub links for the temporary **setup PAT** and persistent **workflow PAT**. Confirm the correct GitHub account, target repository and grants for each role. Review files, Variables, Secret names and temporary permission checks in the plan before approving; then complete the separate **Apply setup** confirmation.

## 4. Install and verify

Review and commit the generated installation files, then merge them through your normal review process. Ensure event workflows and Issue Forms are available on the repository's default branch and that the configured development branch contains the files needed by issue branches. See the [installation steps](/setup-web#install-the-generated-files) before testing.

Run `copilot doctor --read-only` with a valid setup PAT to inspect files and GitHub metadata. Resolve reported failures, then complete [Your first issue-to-PR workflow](/first-workflow). A passing metadata inspection alone does not verify the bot credentials or runtime.

<Info>
  The installed release/hotfix templates are registry-neutral. Before launching either capability, install its publishing and continuation workflows on the default branch, add your own build/deployment steps, and complete the [release preflight](/guides/releases-and-hotfixes#before-launching-a-release).
</Info>

Next: [choose another goal](/guides), inspect the [configuration reference](/configuration), or use the [setup and maintenance reference](/how-to-use) for terminal automation and manual integration.