Skip to main content

Setup

Time: ~10 minutes

Prerequisites​

  • A GitHub account with Copilot enabled
  • Git installed locally
  • Node.js 22+ (only needed if you run the demo app on your own machine)
  • GNU Make and a Unix-like shell (macOS, Linux, or Windows with WSL)

Windows users: Use WSL or a GitHub Codespace for the repository exercises. The demo Makefile uses Unix shell commands that do not run in PowerShell alone.

Step 1: Set up Copilot​

This workshop is written for the GitHub Copilot app. It's the recommended path: sessions run in isolated worktrees, so you can work through exercises in parallel without them colliding.

Start with the onboarding guide

For the complete account, environment, installation, and verification flow, follow the Copilot onboarding guide. Return here once the GitHub Copilot app is installed and signed in.

New to the app? Take the short GitHub Copilot app tour to learn where Sessions, Chats, My Work, Automations, Customize, and Search live, and when to use Interactive, Plan, and Autopilot modes.

Alternatives​

Many exercises also work in an IDE or Copilot CLI. These alternatives operate in your current checkout instead of creating an isolated app worktree, so use a branch per exercise and commit before moving on. App-specific exercises that use My work, app automations, or pull request sessions should still be completed in the GitHub Copilot app.

  • VS Code — install the GitHub Copilot extension and sign in.
  • GitHub Copilot CLI — install Copilot CLI, run copilot from the repository, and use its interactive session from your exercise branch.
  • GitHub Codespaces — open the demo repository in a codespace. Copilot is already available; skip the local install steps below.

Step 2: Get the demo repository​

Make your own copy of the Octocat Supply demo application, then set it up:

git clone <your-copy-url> demo_copilot_agent
cd demo_copilot_agent
make install

If you're using the GitHub Copilot app, add this folder as a project so you can start sessions against it.

Step 3: Verify the build​

make build
make db-init

Both commands should complete without errors before you continue.

Automation module: Copilot app automations require a private or internal repository, including local and manually triggered automations. Use an approved private/internal workshop copy to complete the app-automation exercise; with a public copy, review that exercise without creating or running the automation.

Step 4: Codespaces only — expose the ports​

If you're working in a codespace, make ports 3000 and 5137 public so you can open the app in a browser:

  1. Open the Ports tab in the bottom panel.
  2. Right-click each port and select Port Visibility → Public.

Next Steps​

Once your environment is ready, take the GitHub Copilot App Tour, then continue to Feature Development.