copilot.lua

# copilot.lua

This plugin is the pure lua replacement for [github/copilot.vim](https://github.com/github/copilot.vim).
A huge thank you to @tris203 for the code behind the nes functionality ([copilot-lsp](https://github.com/copilotlsp-nvim/copilot-lsp)).

<details>
<summary>Motivation behind `copilot.lua`</summary>

While using `copilot.vim`, for the first time since I started using neovim my laptop began to overheat. Additionally,
I found the large chunks of ghost text moving around my code, and interfering with my existing cmp ghost text disturbing.
As lua is far more efficient and makes things easier to integrate with modern plugins, this repository was created.

</details>

## Table Of Contents

<!--toc:start-->

- [Requirements](#requirements)
- [Install](#install)
  - [Authentication](#authentication)
    - [Authentication with Alternate GitHub Instances](#authentication-with-alternate-github-instances)
- [Setup and Configuration](#setup-and-configuration)
  - [panel](#panel)
  - [suggestion](#suggestion)
  - [Highlight Groups](#highlight-groups)
  - [filetypes](#filetypes)
  - [logger](#logger)
  - [copilot_node_command](#copilot_node_command)
  - [server_opts_overrides](#server_opts_overrides)
  - [workspace_folders](#workspace_folders)
  - [root_dir](#root_dir)
  - [should_attach](#should_attach)
  - [server](#server)
- [Commands](#commands)
- [Integrations](#integrations)
- [FAQ](#faq)

<!--toc:end-->

## Requirements

- NeoVim 0.11.0 or higher
- NodeJS v22 or higher only when using `server = { type = "nodejs" }`

The native Copilot Language Server is the default. On supported platforms, the
first use asynchronously downloads about 75-110 MB depending on the pinned
release and platform. It is cached under
`stdpath("data")/copilot.lua/lsp`. Downloads are version-pinned and SHA-256
verified. A first install or cache miss needs a transport (`curl`, `wget`, or
PowerShell), hashing, and extraction tool. Unix cache hits and custom paths need
none; Windows cache hits use PowerShell to validate the cached files' ACLs.
Successful installs are extracted into private staging and atomically published
to a cache path keyed by version, platform, and SHA-256. Interrupted staging
directories are ignored and cleaned later. Concurrent first runs may duplicate
a download, but they reuse the first complete published install.

Native binaries are supported on Linux x64/arm64 with glibc, macOS x64/arm64,
and Windows x64/arm64. Musl Linux and other unsupported systems must use
`server = { type = "nodejs" }`.

## Install

Install the plugin with your preferred plugin manager.
For example, with [packer.nvim](https://github.com/wbthomason/packer.nvim):

```lua
use { "zbirenbaum/copilot.lua"
  requires = {
    "copilotlsp-nvim/copilot-lsp", -- (optional) for NES functionality
  },
}
```

### Authentication

You can authenticate using one of the following methods:

<details>
<summary>Permanent sign-in (Recommended)</summary>

Once copilot is running, run `:Copilo