Skip to content

LETHALDOSE1300/copilot-cli

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Copilot CLI (Public Preview)

The power of GitHub Copilot, now in your terminal.

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.

See our official documentation for more information.

Image of the splash screen for the Copilot CLI

🚀 Introduction and Overview

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.

  • Terminal-native development: Work with Copilot coding agent directly in your command line — no context switching required.
  • GitHub integration out of the box: Access your repositories, issues, and pull requests using natural language, all authenticated with your existing GitHub account.
  • Agentic capabilities: Build, edit, debug, and refactor code with an AI collaborator that can plan and execute complex tasks.
  • 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.
  • Full control: Preview every action before execution — nothing happens without your explicit approval.

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.

📦 Getting Started

Supported Platforms

  • Linux
  • macOS
  • Windows

Prerequisites

  • Node.js v22 or higher
  • npm v10 or higher
  • (On Windows) PowerShell v6 or higher
  • An active Copilot subscription. See Copilot plans.

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 for more information.

Installation

Install globally with npm:

npm install -g @github/copilot

Windows PowerShell execution policy

If you see running scripts is disabled on this system when running the npm command in PowerShell, update your execution policy for the current user before retrying the install:

Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned
npm install -g @github/copilot

Alternatively, you can start a PowerShell session with a temporary bypass:

powershell -ExecutionPolicy Bypass -Command "npm install -g @github/copilot"

Or run the Windows command-shell shim directly without changing the policy:

& (Get-Command npm).Source install -g @github/copilot

See about Execution Policies for more details about how PowerShell governs script execution.

Launching the CLI

copilot

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.

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.

Authenticate with a Personal Access Token (PAT)

You can also authenticate using a fine-grained PAT with the "Copilot Requests" permission enabled.

  1. Visit https://github.com/settings/personal-access-tokens/new
  2. Under "Permissions," click "add permissions" and select "Copilot Requests"
  3. Generate your token
  4. Add the token to your environment via the environment variable GH_TOKEN or GITHUB_TOKEN (in order of precedence)

Using the CLI

Launch copilot in a folder that contains code you want to work with.

By default, copilot utilizes Claude Sonnet 4.5. Run the /model slash command to choose from other available models, including Claude Sonnet 4 and GPT-5

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.

For more information about how to use the GitHub Copilot CLI, see our official documentation.

Working with non-GitHub assistants

The CLI is a thin shell around GitHub's Copilot coding agent, so you can choose from every model that the agent exposes — including GPT-5 and Claude Sonnet — without leaving your terminal. To switch between them, run /model inside a session and pick the assistant that best matches the task you're working on.

If you maintain prompt libraries or research corpora outside GitHub, you can still bring that context into a CLI conversation. Use the @ mention shortcut to attach any local file (text, Markdown, JSON, etc.) so the agent has the material you want it to reference while it plans or writes code. This makes it easy to reuse the same assets you would normally feed into ChatGPT or Claude.

Example: referencing a Hugging Face dataset of prompts

If you want to keep the curated prompts from the fka/awesome-chatgpt-prompts dataset close at hand, export them into a local note and attach that note in your Copilot CLI sessions:

pip install datasets

python - <<'PY'
from datasets import load_dataset

dataset = load_dataset("fka/awesome-chatgpt-prompts")

with open("awesome-chatgpt-prompts.md", "w", encoding="utf-8") as handle:
    for row in dataset["train"]:
        handle.write(f"### {row['act']}\n\n{row['prompt']}\n\n")
PY

Once the file exists, launch copilot from the same directory and add the note to your message with @awesome-chatgpt-prompts.md. The agent will ingest the prompt catalog alongside your repository context so you can remix those ideas in your workflow.

📢 Feedback and Participation

We're excited to have you join us early in the Copilot CLI journey.

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!

Your insights are invaluable! Open issue in this repo, join Discussions, and run /feedback from the CLI to submit a confidential feedback survey!

About

GitHub Copilot CLI brings the power of Copilot coding agent directly to your terminal.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors