copilot-cli README

The project's README from github.com/github/copilot-cli. As one markdown file: README.md.

GitHub Copilot CLI

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.

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

Prerequisites

If you have access to GitHub Copilot via your organization or 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 with the install script (macOS and Linux):

curl -fsSL https://gh.io/copilot-install | bash

Or

wget -qO- https://gh.io/copilot-install | bash

Use | sudo bash to run as root and install to /usr/local/bin.

Set PREFIX to install to $PREFIX/bin/ directory. Defaults to /usr/local when run as root or $HOME/.local when run as a non-root user.

Set VERSION to install a specific version. Defaults to the latest version.

For example, to install version v0.0.369 to a custom directory:

curl -fsSL https://gh.io/copilot-install | VERSION="v0.0.369" PREFIX="$HOME/custom" bash

Install with Homebrew (macOS and Linux):

brew install copilot-cli

brew install copilot-cli@prerelease

Install with WinGet (Windows):

winget install GitHub.Copilot

winget install GitHub.Copilot.Prerelease

Install with npm (macOS, Linux, and Windows):

npm install -g @github/copilot

npm install -g @github/copilot@prerelease

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.

Experimental Mode

Experimental mode enables access to new features that are still in development. You can activate experimental mode by:

Once activated, the setting is persisted in your config, so the --experimental flag is no longer needed on subsequent launches.

Experimental Features

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.

🔧 Configuring LSP Servers

GitHub Copilot CLI supports Language Server Protocol (LSP) for enhanced code intelligence. This feature provides intelligent code features like go-to-definition, hover information, and diagnostics.

Installing Language Servers

Copilot CLI does not bundle LSP servers. You need to install them separately. For example, to set up TypeScript support:

npm install -g typescript-language-server

For other languages, install the corresponding LSP server and configure it following the same pattern shown below.

Configuring LSP Servers

LSP servers are configured through a dedicated LSP configuration file. You can configure LSP servers at the user level or repository level:

User-level configuration (applies to all projects): Edit ~/.copilot/lsp-config.json

Repository-level configuration (applies to specific project): Create .github/lsp.json in your repository root

Example configuration:

{
  "lspServers": {
    "typescript": {
      "command": "typescript-language-server",
      "args": ["--stdio"],
      "fileExtensions": {
        ".ts": "typescript",
        ".tsx": "typescript"
      }
    }
  }
}

Viewing LSP Server Status

Check configured LSP servers using the /lsp command in an interactive session, or view your configuration files directly.

For more information, see the changelog.

📢 Feedback and Participation

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

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 an issue in this repo, join Discussions, and run /feedback from the CLI to submit a confidential feedback survey!

copilot-cli (github/copilot-cli)

Searching Database…

11.3K ·GitHub
Copilot-cli
Что это такое?GitHub Copilot CLI переносит агентного помощника по программированию GitHub Copilot в ваш терминал: с его помощью можно создавать, отлаживать и разбирать код на естественном языке, при этом он остаётся связан с вашими репозиториями, issues и PR на GitHub.
Это самостоятельное приложение командной строки (CLI) или библиотека, которую я подключаю к своему коду?Это самостоятельное приложение для терминала: вы запускаете его и общаетесь с ним в интерактивном режиме. Работает оно на той же агентной основе, что и агент для программирования GitHub Copilot.
Как его установить и запустить?Установите через установочный скрипт на macOS/Linux, Homebrew, WinGet на Windows или npm на любой из этих трёх платформ, затем запустите 'copilot' в папке проекта и войдите с помощью слеш-команды '/login'.
Нужна ли мне подписка Copilot, чтобы им пользоваться?Да, нужна действующая подписка GitHub Copilot (или доступ через организацию или предприятие, который администратор не отключил); на Windows также нужен PowerShell v6+.
Может ли моя организация заблокировать мне доступ к этому, даже если у меня есть Copilot?Да — если владелец организации или администратор предприятия отключил Copilot CLI в настройках организации или предприятия, вы не сможете им пользоваться, даже при наличии подписки.
Может ли оно менять мой код без моего согласия?Нет, каждое действие, которое предлагает агент, сначала показывается вам для предварительного просмотра и выполняется только после вашего явного подтверждения.
Какие ИИ-модели можно использовать?По умолчанию используется Claude Sonnet 4.5, но можно переключиться на другие модели, например Claude Sonnet 4 или GPT-5, с помощью слеш-команды '/model'.
Можно ли расширить его возможности внешними инструментами?Да, по умолчанию в комплекте идёт сервер MCP от GitHub, а также можно подключать свои серверы MCP для дополнительных возможностей.
Что такое режим Autopilot?Это экспериментальный режим (включается флагом '--experimental'), в котором агент продолжает работать над задачей до её завершения; переключается клавишами Shift+Tab.
Поддерживает ли оно функции навигации по коду, например переход к определению?Да, поддерживаются серверы Language Server Protocol (LSP), но серверы LSP нужно установить самостоятельно и настроить через файл '.copilot/lsp-config.json' или '.github/lsp.json' на уровне репозитория.
What are similar projects?Baize, headroom, git-ai, kimi-code, qwen-code, claurst, superset, openrig
Which topics is it in?github-copilot, ai-coding, coding-agents, chatbot, shell, command-line, coding-agent, productivity, command-line-tool, agent, mcp, npm
Creator
github
Size
0.4 MB
Stars
11.3K
Updated
CommitOct 14Releasev1.0.98Oct 14
Age
3y
Commits · 90 Days