Skip to content
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 68 additions & 27 deletions workshop/side-quest-01-02-environment-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,64 @@ Knowing which name maps to which role helps you follow workshop instructions wit
> [!NOTE]
> **GitHub Enterprise (GHES/GHEC) users**: the same tools and commands apply in enterprise environments. Your Codespace URL and GitHub URLs will use your enterprise hostname instead of `github.com`. If your enterprise uses a self-hosted runner, the `gh aw compile` command still runs locally in your Codespace — see [Step 6](06-install-gh-aw.md) for any environment-specific install notes.

### :dart: Quick check — match the tool to its role

Before moving on, try matching each item to its role from memory, then reveal the answer.

**1.** Which tool compiles agentic workflow files in the terminal?

<details>
<summary>Reveal answer</summary>

The **`gh-aw` CLI extension** — you install it in [Step 6](06-install-gh-aw.md) and run `gh aw compile`.

</details>

**2.** Which surface gives you AI help directly inside the terminal?

<details>
<summary>Reveal answer</summary>

**GitHub Copilot CLI** — the primary AI surface used throughout this workshop.

</details>

**3.** Which environment is pre-launched for you in golden-ticket workshops and hosts your editor and terminal in the browser?

<details>
<summary>Reveal answer</summary>

**GitHub Codespaces**.

</details>

**4.** Which tool manages GitHub-specific terminal tasks like authentication checks and repository shortcuts?

<details>
<summary>Reveal answer</summary>

**GitHub CLI (`gh`)**.

</details>

**5.** Which desktop/web app lets you start agent sessions and review pull requests outside the terminal?

<details>
<summary>Reveal answer</summary>

The **GitHub Copilot app**.

</details>

**6.** Name one non-default AI model family this workshop mentions besides the default.

<details>
<summary>Reveal answer</summary>

**Claude** or **OpenAI Codex** — used in steps that select a non-default model.

</details>

### :white_check_mark: Verify your tools are ready

Open a terminal in your Codespace and run:
Expand All @@ -53,32 +111,26 @@ gh aw --version

## Conceptual screenshots

Recognizing what each environment looks like on screen helps you orient yourself quickly when workshop instructions say "open a terminal" or "use the Copilot app."

These visuals are simplified mental models, not literal product screenshots. Use them to recognize what each name refers to when it appears in later steps.
These simplified mental models (not literal product screenshots) help you recognize each name when it appears in later steps.

### Development environments

#### GitHub Codespaces
#### GitHub Codespaces and VS Code

<picture>
<source media="(prefers-color-scheme: dark)" srcset="images/side-quest-01-02-github-codespaces-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="images/side-quest-01-02-github-codespaces-light.svg">
<img alt="Conceptual screenshot of GitHub Codespaces showing a browser-based editor, repository explorer, and integrated terminal" src="images/side-quest-01-02-github-codespaces-light.svg">
</picture>

You use Codespaces when you want a ready-to-go development environment in your browser.

#### Visual Studio Code (VS Code)
Codespaces gives you a ready-to-go development environment in your browser, built on the same VS Code editor experience shown below.

<picture>
<source media="(prefers-color-scheme: dark)" srcset="images/side-quest-01-02-vscode-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="images/side-quest-01-02-vscode-light.svg">
<img alt="Conceptual screenshot of Visual Studio Code showing the Explorer, open editor tabs, and integrated terminal" src="images/side-quest-01-02-vscode-light.svg">
</picture>

You use VS Code to browse files, edit workflows, and keep a terminal open beside your work.

#### Terminal (command line)

<picture>
Expand All @@ -91,70 +143,59 @@ You use the terminal whenever the workshop asks you to run `gh`, `gh aw`, or `gi

### Workshop tools and model options

#### GitHub CLI (`gh`)
#### GitHub CLI (`gh`) and `gh-aw` extension

<picture>
<source media="(prefers-color-scheme: dark)" srcset="images/side-quest-01-02-gh-cli-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="images/side-quest-01-02-gh-cli-light.svg">
<img alt="Conceptual screenshot of GitHub CLI showing authentication, repository, and workflow commands in a terminal" src="images/side-quest-01-02-gh-cli-light.svg">
</picture>

You use `gh` for GitHub-specific terminal tasks like authentication checks, repository shortcuts, and workflow commands.

#### `gh-aw` CLI extension
`gh` handles GitHub-specific terminal tasks (auth, repo shortcuts); the `gh-aw` extension adds `gh aw compile` for agentic workflow files.

<picture>
<source media="(prefers-color-scheme: dark)" srcset="images/side-quest-01-02-gh-aw-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="images/side-quest-01-02-gh-aw-light.svg">
<img alt="Conceptual screenshot of the gh-aw CLI extension showing compile commands for an agentic workflow" src="images/side-quest-01-02-gh-aw-light.svg">
</picture>

You use `gh aw` to compile agentic workflow files.

#### GitHub Copilot CLI
#### GitHub Copilot CLI and app

<picture>
<source media="(prefers-color-scheme: dark)" srcset="images/side-quest-01-02-copilot-cli-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="images/side-quest-01-02-copilot-cli-light.svg">
<img alt="Conceptual screenshot of GitHub Copilot CLI showing a terminal prompt alongside AI-assisted command help" src="images/side-quest-01-02-copilot-cli-light.svg">
</picture>

You use GitHub Copilot CLI when you want AI help inside the terminal.

#### GitHub Copilot app
Copilot CLI gives you AI help inside the terminal; the Copilot app (below) lets you start and steer repository sessions, manage coding tasks, and review pull requests from a browser or desktop workspace.

<picture>
<source media="(prefers-color-scheme: dark)" srcset="images/side-quest-01-02-copilot-app-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="images/side-quest-01-02-copilot-app-light.svg">
<img alt="Conceptual screenshot of the GitHub Copilot app showing a repository session, agent chat, and pull request view" src="images/side-quest-01-02-copilot-app-light.svg">
</picture>

You use the GitHub Copilot app when you want to start and steer repository sessions, manage coding tasks, and review pull requests from a Copilot workspace.

#### Claude
#### Claude and OpenAI Codex

<picture>
<source media="(prefers-color-scheme: dark)" srcset="images/side-quest-01-02-claude-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="images/side-quest-01-02-claude-light.svg">
<img alt="Conceptual screenshot of a Claude-style workspace showing a prompt, reasoning path, and structured response" src="images/side-quest-01-02-claude-light.svg">
</picture>

You may see Claude as one of the AI model options that can read a brief, reason through a task, and produce an output.

#### OpenAI Codex
Claude and OpenAI Codex are non-default AI model options available in some steps — both read a brief and produce a response or code patch.

<picture>
<source media="(prefers-color-scheme: dark)" srcset="images/side-quest-01-02-openai-codex-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="images/side-quest-01-02-openai-codex-light.svg">
<img alt="Conceptual screenshot of an OpenAI Codex-style coding workspace showing repository files and a suggested patch" src="images/side-quest-01-02-openai-codex-light.svg">
</picture>

You may see OpenAI Codex as a coding-focused model option that reads files and suggests edits.

<!-- journey: all -->
## :white_check_mark: Checkpoint

- [ ] You can name each environment and tool used in this workshop and describe its role
- [ ] You completed the quick match-the-tool-to-its-role quiz above
- [ ] You ran `gh --version` in your terminal and it returned a version number
- [ ] You ran `git --version` in your terminal and it returned a version number
- [ ] If you've completed [Install the `gh-aw` CLI Extension](06-install-gh-aw.md): you ran `gh aw --version` and it returned a version number
Expand Down