Side Quest: Install gh-aw in a Local Terminal

Optional: install gh-aw on your own machine instead of in the recommended Codespace.

Using a Codespace instead? Return to Install the gh-aw CLI Extension.

:dart: What You'll Do

You'll verify the gh CLI is authenticated, install the gh-aw extension, and run one quick diagnostic to confirm your local terminal is ready for agentic workflow setup.

:clipboard: Before You Start

• You've completed What Are Agentic Workflows?
• You've completed Side Quest: Set Up Your Local Terminal
• The gh CLI is installed and authenticated (completed in Authenticate the gh CLI)

Run this to confirm gh is authenticated before continuing:

gh auth status

Expected output: Logged in to github.com as <your-username>. If you see an error about gh not being installed, return to Prerequisites. For authentication errors, return to Authenticate the gh CLI.

Install from terminal

Check whether gh-aw is already installed, then install or update accordingly:

gh aw --version

• Version shown? Update the extension: gh extension upgrade github/gh-aw
• Command not found? Install the extension (open your terminal — in VS Code use Ctrl+` / Cmd+`):

gh extension install github/gh-aw

curl -sL https://raw.githubusercontent.com/github/gh-aw/main/install-gh-aw.sh | bash

Verify the extension is ready:

gh aw --version

You should see output like gh-aw version 0.88.2.

Run a quick diagnostic

Now run:

gh aw doctor

This verifies your GitHub CLI authentication using the same setup checks gh-aw expects before later authoring and compile steps.

Expected result: a success message confirming GitHub CLI authentication. If it fails, use Side Quest: Install gh-aw Troubleshooting, then rerun gh aw doctor.

Initialize agentic workflow skills

Before you author your first workflow, initialize and push the generated skill files:

gh aw init
git add .
git commit -m "Initialize agentic workflow skills"
git push

This configures .gitattributes and .vscode/settings.json, creates .github/skills/agentic-workflows/SKILL.md, and removes legacy prompt files from .github/prompts/ if they exist.

When you run gh aw init --engine copilot, it also creates .github/agents/agentic-workflows.md. Unless you pass --no-mcp, it also creates .github/workflows/copilot-setup-steps.yml and .github/mcp.json.

If any workflow uses expires, gh aw init also generates .github/workflows/agentics-maintenance.yml.

:running_man: Try It

Run gh aw --help and scan the list of sub-commands.

Which one sub-command do you expect to use in Step 7 when you create and run your first workflow?

:white_check_mark: Checkpoint

• gh auth status shows you are logged in to github.com
• gh aw --version returns a version number
• gh aw doctor completes successfully
• gh aw init has been run in your practice repository
• All files generated by gh aw init are committed and pushed
• You can name one gh aw sub-command from gh aw --help

Want to understand how Copilot authenticates with your workflow? :arrow_right: Side Quest: Configure GitHub Copilot for Agentic Workflows

Next: Write Your First Agentic Workflow