Skip to content

Commit 1345e49

Browse files
GeekTrainerCopilot
GeekTrainer
and
Copilot
committed
docs: add Caldova AI Tour edition of the Copilot CLI workshop
Add the Caldova-themed cli-caldova harness (built from the geektrainer/ caldova-careers template), wire it into the Starlight sidebar, refresh the create-from-template screenshot, and extend the cSpell dictionary. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 7fd1673d-806b-4db8-bffd-9841a406d247
1 parent 0fd0011 commit 1345e49

13 files changed

Lines changed: 1165 additions & 0 deletions

‎.vscode/settings.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
{
22
"cSpell.words": [
33
"agentic",
4+
"Caldova",
5+
"frontmatter",
6+
"geektrainer",
7+
"subfolders",
48
"winget"
59
],
610
"typescript.tsdk": "website/node_modules/typescript/lib"

‎docs/_images/ex0-repository-settings.png‎

-255 KB
Loading

‎docs/cli-caldova/0-prerequisites.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
title: "Exercise 0: Prerequisites"
3+
authors:
4+
- geektrainer
5+
lastUpdated: 2026-06-30
6+
---
7+
8+
Before you start the Copilot CLI exercises, you need to get everything ready. You'll create your own copy of the Caldova Careers repository and spin up a [codespace][codespaces], whose integrated terminal you'll use to install and run Copilot CLI in the next exercise.
9+
10+
## Setting up the lab repository
11+
12+
To create a copy of the repository for the code you'll create, you'll make an instance from the [template][template-repository]. The new instance will contain all of the necessary files for the lab, and you'll use it as you work through the exercises.
13+
14+
1. In a new browser window, navigate to the GitHub repository for this lab: `https://github.com/geektrainer/caldova-careers`.
15+
2. Create your own copy of the repository by selecting the **Use this template** button on the lab repository page. Then select **Create a new repository**.
16+
17+
![Use this template button](../_images/ex0-use-template.png)
18+
19+
3. If you are completing the workshop as part of an event being led by GitHub or Microsoft, follow the instructions provided by the mentors. Otherwise, you can create the new repository in an organization where you have access to GitHub Copilot.
20+
21+
![Input the repository template settings](../_images/ex0-repository-settings.png)
22+
23+
4. Make a note of the repository path you created (**organization-or-user-name/repository-name**), as you will be referring to this later in the lab.
24+
25+
> [!NOTE]
26+
> **Your backlog is ready**
27+
>
28+
> When you create your repository from the template, a short setup workflow runs automatically and files a backlog of GitHub issues for you — including the feature work you'll pick up in later exercises. You'll work from these issues throughout the workshop; there's nothing to file yourself. If the **Issues** tab looks empty immediately after creation, give the workflow a minute to finish and refresh.
29+
## Creating a codespace
30+
31+
Next up, you'll use a codespace to complete the lab exercises.
32+
33+
[GitHub Codespaces][codespaces] are a cloud-based development environment that allows you to write, run, and debug code directly in your browser. It provides a fully-featured IDE with support for multiple programming languages, extensions, and tools.
34+
35+
1. Navigate to your newly created repository.
36+
2. Select the green **Code** button.
37+
38+
![Select the Code button](../_images/ex0-code-button.png)
39+
40+
3. Select the **Codespaces** tab and select the **+** button to create a new Codespace.
41+
42+
![Create a new codespace](../_images/ex0-create-codespace.png)
43+
44+
The creation of the codespace will take several minutes, although it's still far quicker than having to manually install all the services! That said, you can use this time to explore other features of GitHub Copilot, which we'll turn your attention to next.
45+
46+
> [!CAUTION]
47+
> You'll return to the codespace in a future exercise. For the time being, leave it open in a tab in your browser.
48+
49+
> [!NOTE]
50+
> This workshop is built to run inside a codespace or local [dev container][dev-containers]. Both ensure the environment has all the necessary prerequisites installed for a smooth experience. If you'd prefer to run it locally, open the cloned repository in VS Code and select **Reopen in Container** when prompted — VS Code will build the same dev container the codespace uses.
51+
52+
> [!TIP]
53+
> The setup workflow removes itself with a small commit after it files your backlog. If you created your codespace right away, run `git pull` in the codespace terminal once it's ready so you're on the latest commit before you start working.
54+
55+
## Summary
56+
57+
Congratulations, you have created a copy of the lab repository! You also began the creation process of your codespace, which you'll use when you begin working with Copilot CLI.
58+
59+
## Next step
60+
61+
Let's install Copilot CLI and authenticate it with your GitHub account. Continue to [Exercise 1 - Installing GitHub Copilot CLI][next-lesson].
62+
63+
## Resources
64+
65+
- [GitHub Codespaces overview][codespaces]
66+
- [Creating a repository from a template][template-repository]
67+
- [Getting started with Codespaces][codespaces-quickstart]
68+
69+
[template-repository]: https://docs.github.com/repositories/creating-and-managing-repositories/creating-a-template-repository
70+
[codespaces-quickstart]: https://docs.github.com/codespaces/getting-started/quickstart
71+
[next-lesson]: ../1-install-copilot-cli/
72+
[codespaces]: https://github.com/features/codespaces
73+
[dev-containers]: https://code.visualstudio.com/docs/devcontainers/containers

‎docs/cli-caldova/1-install-copilot-cli.md‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
---
2+
title: "Exercise 1 - Installing GitHub Copilot CLI"
3+
authors:
4+
- geektrainer
5+
lastUpdated: 2026-06-30
6+
---
7+
8+
[GitHub Copilot CLI][about-copilot-cli] is a powerful agentic coding assistant that runs in your terminal, enabling you to explore codebases, generate code, run commands, and interact with external tools - all from the command line. It allows you to offload tasks, request changes, and stay in the zone. The first step, as you might imagine, is to install the tool! Fortunately this can be done using tools you're already familiar with.
9+
10+
In this exercise, you will learn how to:
11+
12+
- install GitHub Copilot CLI using npm.
13+
- authenticate with your GitHub account.
14+
- verify the installation.
15+
16+
## Scenario
17+
18+
Your team is starting to use AI agents to work through a growing backlog. Copilot CLI brings that capability into the terminal, where many developers already live. This exercise gets you installed, authenticated, and ready to use it for the rest of the workshop.
19+
20+
## Open a terminal in your codespace
21+
22+
Before installing Copilot CLI, you need to open a terminal window in your codespace.
23+
24+
1. Return to your codespace if you're not already there.
25+
2. Open a terminal window by pressing <kbd>Ctrl</kbd>+<kbd>\`</kbd>.
26+
3. You should see a terminal panel appear at the bottom of your VS Code window.
27+
28+
## Install Copilot CLI
29+
30+
You can install Copilot CLI through [npm][install-npm], [WinGet][install-winget], and [Homebrew][install-homebrew]. Since GitHub Codespaces come with Node.js pre-installed you'll use npm to install Copilot CLI.
31+
32+
1. In the terminal, verify Node.js is installed and meets the version requirement:
33+
34+
```bash
35+
node --version
36+
```
37+
38+
You should see version 22 or higher (e.g., `v22.x.x`).
39+
40+
2. Install Copilot CLI globally in the codespace using npm:
41+
42+
```bash
43+
npm install -g @github/copilot
44+
```
45+
46+
3. Verify the installation by checking the version:
47+
48+
```bash
49+
copilot --version
50+
```
51+
52+
You should see the version number displayed (e.g., `v1.0.XX`).
53+
54+
> [!TIP]
55+
> If you encounter permission errors, you may need to use `sudo npm install -g @github/copilot` on some systems. However, this shouldn't be necessary in GitHub Codespaces.
56+
57+
## Authenticate with GitHub
58+
59+
On first launch, Copilot CLI will prompt you to authenticate with your GitHub account.
60+
61+
1. Start Copilot CLI:
62+
63+
```bash
64+
copilot
65+
```
66+
67+
2. If you're not currently logged in, you'll see a prompt to authenticate. Copilot CLI will display a device code and ask you to visit a URL.
68+
3. Follow the on-screen instructions:
69+
- Open the provided URL in your browser
70+
- Enter the device code when prompted
71+
- Authorize Copilot CLI to access your GitHub account
72+
4. Once authenticated, you'll see the Copilot CLI prompt, ready to accept your questions and commands.
73+
74+
> [!NOTE]
75+
> In a codespace, you may already be authenticated through your GitHub session. If Copilot CLI starts without prompting for authentication, you're good to go!
76+
77+
## Trust the directory and verify everything is working
78+
79+
Now that you're at the Copilot CLI prompt for the first time, let's trust this workshop repository and make sure Copilot CLI is properly installed and connected.
80+
81+
1. When Copilot CLI asks you to confirm that you trust the files in this folder, you'll see three options:
82+
- **Yes, proceed**: Trust for this session only
83+
- **Yes, and remember this folder for future sessions**: Trust permanently
84+
- **No, exit (Esc)**: Don't allow file access
85+
2. For this workshop, select **Yes, and remember this folder for future sessions** since you'll be working in this repository throughout.
86+
3. Ask Copilot a simple question to verify it's working:
87+
88+
```
89+
What files are in this project?
90+
```
91+
92+
4. Copilot should explore the repository and provide a summary of the project structure.
93+
5. Try the `/help` command to see available slash commands:
94+
95+
```
96+
/help
97+
```
98+
99+
6. Exit Copilot CLI by entering the following command in the terminal. We will return back to Copilot CLI in a future exercise!
100+
101+
```
102+
exit
103+
```
104+
105+
## Summary and next steps
106+
107+
Congratulations! You've successfully installed and authenticated GitHub Copilot CLI. You learned how to:
108+
109+
- install Copilot CLI using npm.
110+
- authenticate with your GitHub account.
111+
- trust a directory for Copilot CLI to work with.
112+
- verify the installation is working correctly.
113+
114+
Now that Copilot CLI is installed, let's give Copilot some project context. Continue to [Exercise 2 - Custom instructions with CLI][next-lesson].
115+
116+
## Resources
117+
118+
- [Installing GitHub Copilot CLI][install-copilot-cli]
119+
- [About Copilot CLI][about-copilot-cli]
120+
- [Using Copilot CLI][using-copilot-cli]
121+
122+
[previous-lesson]: ../0-prerequisites/
123+
[next-lesson]: ../2-custom-instructions/
124+
[install-copilot-cli]: https://docs.github.com/copilot/how-tos/set-up/install-copilot-cli
125+
[install-npm]: https://docs.github.com/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli#installing-with-npm-all-platforms
126+
[install-winget]: https://docs.github.com/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli#installing-with-winget-windows
127+
[install-homebrew]: https://docs.github.com/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli#installing-with-homebrew-macos-and-linux
128+
[about-copilot-cli]: https://docs.github.com/copilot/concepts/agents/about-copilot-cli
129+
[using-copilot-cli]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli

0 commit comments

Comments
 (0)