diff --git a/00-quick-start/README.md b/00-quick-start/README.md index a0e1da61..d5c84b67 100644 --- a/00-quick-start/README.md +++ b/00-quick-start/README.md @@ -21,14 +21,11 @@ By the end of this chapter, you'll have: ### What "Copilot Access" Means -GitHub Copilot CLI requires an active Copilot subscription. You can check your status at [github.com/settings/copilot](https://github.com/settings/copilot). You should see one of: +GitHub Copilot CLI requires an active Copilot subscription. You can check your status at [github.com/settings/copilot](https://github.com/settings/copilot). You should see: -- **Copilot Individual** - Personal subscription -- **Copilot Business** - Through your organization -- **Copilot Enterprise** - Through your enterprise -- **GitHub Education** - Free for verified students/teachers +- **Copilot Business** - Through your membership via the UI-Research organization -If you see "You don't have access to GitHub Copilot," you'll need to use the free option, subscribe to a plan, or join an organization that provides access. +If you see "You don't have access to GitHub Copilot," you'll need to use the free option, or request to join the group with access to Copilot via UI-Research. Email jkelly@urban.org for more information about use at Urban. --- @@ -36,38 +33,20 @@ If you see "You don't have access to GitHub Copilot," you'll need to use the fre > ⏱️ **Time estimate**: Installation takes 2-5 minutes. Authentication adds another 1-2 minutes. -### GitHub Codespaces (Zero Setup) - -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. - -1. [Fork this repository](https://github.com/github/copilot-cli-for-beginners/fork) to your GitHub account -2. Select **Code** > **Codespaces** > **Create codespace on main** -3. Wait a few minutes for the container to build -4. You're ready to go! The terminal will open automatically in the Codespace environment. - -> 💡 **Verify in Codespace**: Run `cd samples/book-app-project && python book_app.py help` to confirm Python and the sample app are working. - ### Local Installation -Follow these steps if you'd like to run Copilot CLI on your local machine with the course samples. +Follow these steps to run Copilot CLI on your local machine with the course samples. 1. Clone the repo to get the course samples on your machine: ```bash - git clone https://github.com/github/copilot-cli-for-beginners + git clone https://github.com/UI-Research/copilot-cli-for-beginners cd copilot-cli-for-beginners ``` 2. Install Copilot CLI using one of the following options. - > 💡 **Not sure which to pick?** Use `npm` if you have Node.js installed. Otherwise, choose the option that matches your system. - - ### All Platforms (npm) - - ```bash - # If you have Node.js installed, this is a quick way to get the CLI - npm install -g @github/copilot - ``` + > If you have Windows, you will need to contact helpdesk to schedule installation. ### macOS/Linux (Homebrew) @@ -76,18 +55,10 @@ Follow these steps if you'd like to run Copilot CLI on your local machine with t ``` ### Windows (WinGet) - - ```bash - winget install GitHub.Copilot - ``` - - ### macOS/Linux (Install Script) - - ```bash - curl -fsSL https://gh.io/copilot-install | bash - ``` - ---- + + - contact helpdesk to schedule install. + - frequently requires a Powershell update first. + ## Authentication @@ -97,6 +68,8 @@ Open a terminal window at the root of the `copilot-cli-for-beginners` repository copilot ``` +> Windows users may need to run `gh copilot` at the command line. + You'll be asked to trust the folder containing the repository (if you haven't already). You can trust it one time or across all future sessions. Trusting files in a folder with the Copilot CLI diff --git a/01-setup-and-first-steps/README.md b/01-setup-and-first-steps/README.md index ac39eddd..66e5acdf 100644 --- a/01-setup-and-first-steps/README.md +++ b/01-setup-and-first-steps/README.md @@ -10,6 +10,7 @@ This chapter is where the magic starts! You'll experience firsthand why develope By the end of this chapter, you'll be able to: +- Know some basic rules of the road for securely using GitHub Copilot CLI at Urban. - Experience the productivity boost GitHub Copilot CLI provides through hands-on demos - Choose the right mode (Interactive, Plan, or Programmatic) for any task - Use slash commands to control your sessions @@ -28,7 +29,9 @@ Jump right in and see what Copilot CLI can do. ## Getting Comfortable: Your First Prompts -Before diving into the impressive demos, let's start with some simple prompts you can try right now. **No code repository needed**! Just open a terminal and start Copilot CLI: +> ⚠️ **Important note on security**: When you run the CLI tool, Copilot will have access to files _at and below_ the directory level you are in. **NEVER run the CLI from your top-level directory** (i.e. `C:\`, `D:\` or `Home`). And you should also **NEVER run the CLI from a directory that contains sensitive or confidential information** as you might then expose those files to risk. + +Before diving into the impressive demos, let's start with some simple prompts you can try right now. **No code repository needed**! Just open a terminal from an appropriate folder not at the root level, and start Copilot CLI: ```bash copilot @@ -66,7 +69,7 @@ The course includes sample files with intentional code quality issues. If you're ```bash # Clone the course repository if you're working locally and haven't already -git clone https://github.com/github/copilot-cli-for-beginners +git clone https://github.com/UI-Research/copilot-cli-for-beginners cd copilot-cli-for-beginners # Start Copilot diff --git a/02-context-conversations/README.md b/02-context-conversations/README.md index 81bfe7a9..f4202c02 100644 --- a/02-context-conversations/README.md +++ b/02-context-conversations/README.md @@ -50,7 +50,7 @@ The `@` symbol references files and directories in your prompts. It's how you te ### Try It Now (No Setup Required) -You can try this with any file on your computer: +You can try this with any file on your computer from an appropriate folder not at the root level, that does not contain confidential data: ```bash copilot diff --git a/04-agents-custom-instructions/README.md b/04-agents-custom-instructions/README.md index a84d8894..ceb9da75 100644 --- a/04-agents-custom-instructions/README.md +++ b/04-agents-custom-instructions/README.md @@ -677,7 +677,7 @@ You are a technical writer who creates clear Python documentation. **Testing your agents:** > 💡 **Note:** You should already have `samples/book-app-project/data.json` in your local copy of this repo. If it is missing, download the original version from the source repo: -> [data.json](https://github.com/github/copilot-cli-for-beginners/blob/main/samples/book-app-project/data.json) +> [data.json](https://github.com/UI-Research/copilot-cli-for-beginners/blob/main/samples/book-app-project/data.json) ```bash copilot diff --git a/README.md b/README.md index ffd5ed26..0d1e699e 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,9 @@ 🎯 [What You'll Learn](#what-youll-learn)   ✅ [Prerequisites](#prerequisites)   🤖 [Copilot Family](#understanding-the-github-copilot-family)   📚 [Course Structure](#course-structure)   📋 [Command Reference](#-github-copilot-cli-command-reference) +# About this branch +The `urban-version-for-traning` branch is modified from `main` for Urban-recommended set up steps as of April 2026. + # GitHub Copilot CLI for Beginners > **✨ Learn to supercharge your development workflow with AI-powered command-line assistance.**