@github/copilot 0.0.326
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +74 -0
- package/index.js +2370 -0
- package/package.json +34 -0
- package/tree-sitter-bash.wasm +0 -0
- package/tree-sitter-powershell.wasm +0 -0
- package/tree-sitter.wasm +0 -0
package/README.md
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# GitHub Copilot CLI (Public Preview)
|
|
2
|
+
|
|
3
|
+
The power of GitHub Copilot, now in your terminal.
|
|
4
|
+
|
|
5
|
+
GitHub Copilot CLI brings AI-powered coding assistance directly to your command line, enabling you to build, debug, and understand code through natural language conversations. Powered by the same agentic harness as GitHub's Copilot coding agent, it provides intelligent assistance while staying deeply integrated with your GitHub workflow.
|
|
6
|
+
|
|
7
|
+
See [our official documentation](https://docs.github.com/copilot/concepts/agents/about-copilot-cli) for more information.
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## 🚀 Introduction and Overview
|
|
12
|
+
|
|
13
|
+
We're bringing the power of GitHub Copilot coding agent directly to your terminal. With GitHub Copilot CLI, you can work locally and synchronously with an AI agent that understands your code and GitHub context.
|
|
14
|
+
|
|
15
|
+
- **Terminal-native development:** Work with Copilot coding agent directly in your command line — no context switching required.
|
|
16
|
+
- **GitHub integration out of the box:** Access your repositories, issues, and pull requests using natural language, all authenticated with your existing GitHub account.
|
|
17
|
+
- **Agentic capabilities:** Build, edit, debug, and refactor code with an AI collaborator that can plan and execute complex tasks.
|
|
18
|
+
- **MCP-powered extensibility:** Take advantage of the fact that the coding agent ships with GitHub's MCP server by default and supports custom MCP servers to extend capabilities.
|
|
19
|
+
- **Full control:** Preview every action before execution — nothing happens without your explicit approval.
|
|
20
|
+
|
|
21
|
+
We're still early in our journey, but with your feedback, we're rapidly iterating to make the GitHub Copilot CLI the best possible companion in your terminal.
|
|
22
|
+
|
|
23
|
+
## 📦 Getting Started
|
|
24
|
+
|
|
25
|
+
### Supported Platforms
|
|
26
|
+
|
|
27
|
+
- **Linux**
|
|
28
|
+
- **macOS**
|
|
29
|
+
- **Windows** (via WSL. Native shell support is experimental)
|
|
30
|
+
|
|
31
|
+
### Prerequisites
|
|
32
|
+
|
|
33
|
+
- **Node.js** v22 or higher
|
|
34
|
+
- **npm** v10 or higher
|
|
35
|
+
- (On Windows) **PowerShell** v6 or higher
|
|
36
|
+
- An **active Copilot subscription**. See [Copilot plans](https://github.com/features/copilot/plans?ref_cta=Copilot+plans+signup&ref_loc=install-copilot-cli&ref_page=docs).
|
|
37
|
+
|
|
38
|
+
If you have access to GitHub Copilot via your organization of enterprise, you cannot use GitHub Copilot CLI if your organization owner or enterprise administrator has disabled it in the organization or enterprise settings. See [Managing policies and features for GitHub Copilot in your organization](http://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/managing-policies-for-copilot-in-your-organization) for more information.
|
|
39
|
+
|
|
40
|
+
### Installation
|
|
41
|
+
|
|
42
|
+
Install globally with npm:
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
npm install -g @github/copilot
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Launching the CLI
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
copilot
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
On first launch, you'll be greeted with our adorable animated banner! If you'd like to see this banner again, launch `copilot` with the `--banner` flag.
|
|
55
|
+
|
|
56
|
+
If you're not currently logged in to GitHub, you'll be prompted to use the `/login` slash command. Enter this command and follow the on-screen instructions to authenticate.
|
|
57
|
+
|
|
58
|
+
### Using the CLI
|
|
59
|
+
|
|
60
|
+
Launch `copilot` in a folder that contains code you want to work with.
|
|
61
|
+
|
|
62
|
+
By default, `copilot` utilizes Claude Sonnet 4. We also support GPT-5 via an environment variable. Run `COPILOT_MODEL=gpt-5 copilot` to launch in GPT-5 mode. Or on Windows, run `set COPILOT_MODEL=gpt-5` before running `copilot`.
|
|
63
|
+
|
|
64
|
+
Each time you submit a prompt to GitHub Copilot CLI, your monthly quota of premium requests is reduced by one. For information about premium requests, see [About premium requests](https://docs.github.com/copilot/managing-copilot/monitoring-usage-and-entitlements/about-premium-requests)
|
|
65
|
+
|
|
66
|
+
For more information about how to use the Copilot CLI, see [our official documentation](https://docs.github.com/copilot/concepts/agents/about-copilot-cli)
|
|
67
|
+
|
|
68
|
+
## 📢 Feedback and Participation
|
|
69
|
+
|
|
70
|
+
We're excited to have you join us early in the Copilot CLI journey.
|
|
71
|
+
|
|
72
|
+
This is an early-stage preview, and we're building quickly. Expect frequent updates--please keep your client up to date for the latest features and fixes!
|
|
73
|
+
|
|
74
|
+
Your insights are invaluable! Open issue in this repo, join Discussions, and run `/feedback` from the CLI to submit a confidential feedback survey!
|