You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If you don't want to install any of the prerequisites, you can use GitHub Codespaces, which has the GitHub Copilot CLI ready to go (you'll need to sign in), pre-installs Python 3.13, pytest, and the GitHub CLI.
41
+
If you don't want to install any of the prerequisites you can use GitHub Codespaces, which has the GitHub Copilot CLI ready to go (you'll need to sign in), and pre-installs Python and pytest.
42
42
43
43
1.[Fork this repository](https://github.com/github/copilot-cli-for-beginners/fork) to your GitHub account
44
44
2. Select **Code** > **Codespaces** > **Create codespace on main**
@@ -47,40 +47,45 @@ If you don't want to install any of the prerequisites, you can use GitHub Codesp
47
47
48
48
> 💡 **Verify in Codespace**: Run `cd samples/book-app-project && python book_app.py help` to confirm Python and the sample app are working.
49
49
50
-
### Alternative: Local Installation
50
+
### Local Installation
51
51
52
-
> 💡 **Not sure which to pick?** Use `npm` if you have Node.js installed. Otherwise, choose the option that matches your system.
52
+
Follow these steps if you'd like to run Copilot CLI on your local machine with the course samples.
53
53
54
-
> 💡 **Python required for demos**: The course uses a Python sample app. If you're working locally, install [Python 3.10+](https://www.python.org/downloads/) before starting the demos.
54
+
1. Clone the repo to get the course samples on your machine:
55
55
56
-
> **Note:** While the primary examples shown throughout the course use Python (`samples/book-app-project`), JavaScript (`samples/book-app-project-js`) and C# (`samples/book-app-project-cs`) versions are also available if you prefer to work with those languages. Each sample has a README with instructions for running the app in that language.
2. Install Copilot CLI using one of the following options.
59
62
60
-
### All Platforms (npm)
63
+
> 💡 **Not sure which to pick?** Use `npm`if you have Node.js installed. Otherwise, choose the option that matches your system.
61
64
62
-
```bash
63
-
# If you have Node.js installed, this is a quick way to get the CLI
64
-
npm install -g @github/copilot
65
-
```
65
+
### All Platforms (npm)
66
66
67
-
### macOS/Linux (Homebrew)
67
+
```bash
68
+
# If you have Node.js installed, this is a quick way to get the CLI
69
+
npm install -g @github/copilot
70
+
```
68
71
69
-
```bash
70
-
brew install copilot-cli
71
-
```
72
+
### macOS/Linux (Homebrew)
72
73
73
-
### Windows (WinGet)
74
+
```bash
75
+
brew install copilot-cli
76
+
```
74
77
75
-
```bash
76
-
winget install GitHub.Copilot
77
-
```
78
+
### Windows (WinGet)
78
79
79
-
### macOS/Linux (Install Script)
80
+
```bash
81
+
winget install GitHub.Copilot
82
+
```
80
83
81
-
```bash
82
-
curl -fsSL https://gh.io/copilot-install | bash
83
-
```
84
+
### macOS/Linux (Install Script)
85
+
86
+
```bash
87
+
curl -fsSL https://gh.io/copilot-install | bash
88
+
```
84
89
85
90
---
86
91
@@ -153,7 +158,7 @@ After you receive a response, you can exit the CLI:
153
158
154
159
The course provides a sample app that you'll explore and improve throughout the course using the CLI *(You can see the code for this in /samples/book-app-project)*. Check that the *Python book collection terminal app* works before you get started. Run `python` or `python3` depending on your system.
155
160
156
-
> **Note:**While the primary examples shown throughout the course use Python (`samples/book-app-project`), JavaScript (`samples/book-app-project-js`) and C# (`samples/book-app-project-cs`) versions are also available if you prefer to work with those languages. Each sample has a README with instructions for running the app in that language.
161
+
> **Note:** The primary examples shown throughout the course use Python (`samples/book-app-project`) so you'll need to have [Python 3.10+](https://www.python.org/downloads/) available on your local machine if you chose that option (the Codespace already has it installed). JavaScript (`samples/book-app-project-js`) and C# (`samples/book-app-project-cs`) versions are also available if you prefer to work with those languages. Each sample has a README with instructions forrunning the appin that language.
Copy file name to clipboardExpand all lines: 01-setup-and-first-steps/README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,7 +62,7 @@ Now let's see why developers are calling this "having a senior engineer on speed
62
62
63
63
### Demo 1: Code Review in Seconds
64
64
65
-
The course includes sample files with intentional code quality issues. Let's review one:
65
+
The course includes sample files with intentional code quality issues. If you're working on your local machine and haven't already cloned the repo, please run the `git clone` command below, navigate to the `copilot-cli-for-beginners` folder, and then run the `copilot` command.
66
66
67
67
```bash
68
68
# Clone the course repository if you're working locally and haven't already
@@ -73,13 +73,13 @@ cd copilot-cli-for-beginners
73
73
copilot
74
74
```
75
75
76
-
Once inside the interactive session:
76
+
Once inside the interactive Copilot CLI session, run the following:
77
77
78
78
```
79
79
> Review @samples/book-app-project/book_app.py for code quality issues and suggest improvements
80
80
```
81
81
82
-
> 💡 **What's the `@`?** The `@` symbol tells Copilot CLI to read a file. You'll learn all about this in Chapter 02. For now, just copy the command exactly as shown.
82
+
> 💡 **What's the `@` symbol used for?** The `@` symbol tells Copilot CLI to read a file. You'll learn all about this in Chapter 02. For now, just copy the command exactly as shown.
0 commit comments