docs: replace npm copilot-cli installation with built-in gh copilot command #13381
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
|
@copilot |
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Updated the documentation to clarify that Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
skills/copilot-cli/SKILL.md
Outdated
| The `gh copilot` command automatically downloads and manages the Copilot CLI installation. No manual installation required! | ||
|
|
||
| > [!TIP] | ||
| > The `gh copilot` command is built into the GitHub CLI and handles installation automatically. If the Copilot CLI is not already installed, it will be downloaded to `~/.local/share/gh/copilot`. To remove it, use `gh copilot --remove`. |
There was a problem hiding this comment.
Removed the detailed TIP callout with download location and removal command. (0bf4fc2)
There was a problem hiding this comment.
Reverted agent-factory-status.mdx to its original state. This file is auto-generated and should not be manually modified. (5566a9c)
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
There was a problem hiding this comment.
Pull request overview
This pull request aims to document the gh copilot command as an alternative method for running GitHub Copilot CLI locally, while also removing the redundant copilot-cli SKILL.md documentation file. The PR updates the engines reference documentation with a new section about local Copilot CLI usage.
Changes:
- Added "Running Copilot CLI Locally" section to engines.md documenting
gh copilotcommand - Deleted skills/copilot-cli/SKILL.md file containing detailed CLI integration documentation
- Updated documentation link from authentication-specific to general CLI reference
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/src/content/docs/reference/engines.md | Added local usage section for gh copilot command, restructured "Required Secrets" heading, updated documentation link |
| skills/copilot-cli/SKILL.md | Complete file deletion removing 233 lines of CLI integration documentation |
Comments suppressed due to low confidence (6)
skills/copilot-cli/SKILL.md:1
- The deletion of this entire SKILL.md file creates a broken reference in AGENTS.md at line 1117, which links to this file with: "- copilot-cli - GitHub Copilot CLI integration for agentic workflows"
This reference needs to be updated or removed as part of this PR to maintain consistency in the codebase. The PR description mentions the file was deleted because it was "redundant with main documentation," but the main documentation (engines.md) doesn't provide the same level of technical detail about CLI usage, MCP configuration, and integration patterns that was previously in this SKILL.md file.
docs/src/content/docs/reference/engines.md:45
- The "Required Secrets" heading placement is confusing. It appears after the "Running Copilot CLI Locally" section, but the secrets are required for the GitHub Agentic Workflows engine configuration, not for running
gh copilotlocally.
This creates a logical disconnect where users might think these secrets are needed for local gh copilot usage. The section should either:
- Be placed before the "Running Copilot CLI Locally" section to maintain the logical flow from engine setup to local usage
- Or the "Running Copilot CLI Locally" section should be removed/relocated since it's not directly related to the workflow engine configuration that precedes it
### Required Secrets
docs/src/content/docs/reference/engines.md:63
- The documentation link has been changed from authentication-specific documentation to a general CLI reference (gh.io/copilot-cli). However, the preceding sentence specifically discusses the COPILOT_GITHUB_TOKEN and authentication requirements.
It would be more helpful to keep a link to authentication documentation here, or add an additional sentence that provides context for what the linked documentation covers. The current change makes it less clear where users should look for authentication-specific guidance.
For more information about GitHub Copilot CLI, see the [official documentation](https://gh.io/copilot-cli).
docs/src/content/docs/reference/engines.md:40
- The command example shows just
gh copilotwithout any arguments or explanation of what it does. This is too minimal to be useful.
Users would benefit from knowing:
- That this launches an interactive assistant (not a one-time command)
- What authentication is required (if any)
- That this is for local developer use, separate from the workflow engine configuration discussed in the rest of this section
Consider adding a brief explanation like: "This launches an interactive AI assistant in your terminal. Authentication is handled automatically through your GitHub CLI login."
```bash wrap
gh copilot
**docs/src/content/docs/reference/engines.md:42**
* The statement that `gh copilot` "is built into the GitHub CLI" may be misleading. Based on the context of the PR description mentioning it "automatically downloads and manages the Copilot CLI installation," it appears that `gh copilot` is more of an extension or automatic downloader rather than being truly "built-in" to the core GitHub CLI.
The phrasing should be clarified to accurately reflect whether this is:
1. A core built-in command shipped with GitHub CLI
2. An extension that's automatically installed/managed
3. A wrapper that downloads the actual Copilot CLI on first use
This distinction is important for users understanding the architecture and dependencies.
The gh copilot command is built into the GitHub CLI and automatically downloads and manages the Copilot CLI installation. No additional installation required - just install the GitHub CLI!
**docs/src/content/docs/reference/engines.md:42**
* There's a significant discrepancy between the PR description and the actual changes. The PR description states this replaces "npm copilot-cli installation with built-in gh copilot command" and shows a before/after comparison suggesting the npm installation workflow is being replaced.
However, the actual changes only add documentation about local `gh copilot` usage without:
1. Removing or replacing any npm installation instructions (which were in the deleted SKILL.md, but that file was for reference, not installation instructions)
2. Updating the actual workflow files (.github/workflows/copilot.yml and test-copilot-github-integration.yml) which still use npm installation
3. Clarifying that workflows/CI continue to use npm while local development can use `gh copilot`
The PR should either:
- Update the description to accurately reflect that this adds local usage documentation alongside existing npm-based workflow usage
- Or expand the changes to actually replace npm installation in workflows (if that's technically feasible)
Running Copilot CLI Locally
To run the GitHub Copilot CLI on your local machine, use the gh copilot command:
gh copilotThe gh copilot command is built into the GitHub CLI and automatically downloads and manages the Copilot CLI installation. No additional installation required - just install the GitHub CLI!
</details>
---
💡 <a href="/github/gh-aw/new/main/.github/instructions?filename=*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.
| ### Running Copilot CLI Locally | ||
|
|
||
| To run the GitHub Copilot CLI on your local machine, use the `gh copilot` command: | ||
|
|
||
| ```bash wrap | ||
| gh copilot | ||
| ``` | ||
|
|
||
| The `gh copilot` command is built into the GitHub CLI and automatically downloads and manages the Copilot CLI installation. No additional installation required - just install the [GitHub CLI](https://cli.github.com/)! | ||
|
|
There was a problem hiding this comment.
The "Running Copilot CLI Locally" section is misleading in this context. The engines.md documentation is about configuring AI engines for GitHub Agentic Workflows (GitHub Actions), not about running the Copilot CLI locally on a developer's machine.
The gh copilot command is an interactive CLI tool for developers to get AI assistance in their terminal, which is different from the @github/copilot npm package used by the workflow engine to execute agentic workflows.
This section should either be removed entirely (since it's not relevant to the workflow engine configuration) or clarified to explain that gh copilot is a separate tool for interactive use, distinct from the workflow engine's automated usage of the Copilot CLI.
This issue also appears in the following locations of the same file:
- line 44
- line 63
- line 38
- line 42
- line 34
| ### Running Copilot CLI Locally | |
| To run the GitHub Copilot CLI on your local machine, use the `gh copilot` command: | |
| ```bash wrap | |
| gh copilot | |
| ``` | |
| The `gh copilot` command is built into the GitHub CLI and automatically downloads and manages the Copilot CLI installation. No additional installation required - just install the [GitHub CLI](https://cli.github.com/)! | |
| ### Relationship to GitHub Copilot CLI | |
| When you configure `engine: copilot` for GitHub Agentic Workflows, the workflow engine uses the `@github/copilot` npm package under the hood while running in GitHub Actions. | |
| This is distinct from the interactive `gh copilot` command provided by the GitHub CLI, which is intended for developers to use manually in their local terminal. Using `gh copilot` is optional and not required to configure or run the Copilot engine for workflows. |
The GitHub CLI includes a built-in
gh copilotcommand that automatically downloads and manages the Copilot CLI. This replaces the manual npm installation workflow.Changes
gh copilotas primary installation method, clarified it's built into GitHub CLIBefore/After
Before:
npm install -g @github/copilot # Manual PATH configuration, version management, troubleshootingAfter:
gh copilot # Built into GitHub CLI, automatic installation managementThe documentation now provides clear, concise guidance without unnecessary implementation details.
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.