copilot.lua

The recommended way to authenticate is via permanent sign-in. Once the plugin is running, execute the :Copilot auth command to start the process.

To manage your account:

• Sign out: :Copilot auth signout
• Sign in with a different account: :Copilot auth signin
• Check status: :Copilot auth info

Credentials are stored in ~/.config/github-copilot/auth.db (Linux/macOS) or ~/AppData/Local/github-copilot/auth.db (Windows).

To deploy GitHub Copilot settings using Microsoft Intune, create a Custom Configuration Profile:

1. In the Microsoft Endpoint Manager admin center, go to Devices → Configuration profiles.
2. Create a new profile:
   • Platform: Windows 10 and later
   • Profile type: Custom
3. Add the following OMA-URI setting:
   • Name: Enable Extension-Contributed MCP Servers
   • OMA-URI: ./Device/Vendor/MSFT/Policy/Config/ADMX_IDEGitHubCopilot/McpContributionPointEnabled
   • Data type: Integer
   • Value: 1 (enabled) or 0 (disabled)
4. Assign the profile to your target device groups.

Workspace folders improve suggestion quality. By default, the root_dir is used. You can add additional folders via configuration or runtime commands.

Runtime command: :Copilot workspace add [folderpath]

workspace_folders = {
  "/home/user/gits",
  "/home/user/projects",
}

Once the templates are installed, you can manage settings through the Windows Group Policy Editor:

1. Open the Editor:
   • Run gpedit.msc (Local Group Policy Editor).
   • Or use gpmc.msc (Group Policy Management Console) for domain environments.
2. Navigate to Policies:
   • Computer Configuration → Administrative Templates → GitHub Copilot
   • User Configuration → Administrative Templates → GitHub Copilot

For enterprise environments, the IDEGitHubCopilot.mobileconfig file can be deployed to target devices using Mobile Device Management (MDM) solutions. Supported solutions include:

• Apple Business Manager
• Jamf Pro
• Microsoft Intune
• VMware Workspace ONE

Simply upload the IDEGitHubCopilot.mobileconfig file to your MDM solution and assign it to the desired device groups.

Install the plugin using your preferred Neovim plugin manager. If you want to use Next Edit Suggestion (NES) functionality, you should also include copilotlsp-nvim/copilot-lsp as a requirement.

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

To start Copilot, you must call require("copilot").setup(options). If no options are provided, the plugin uses its default configuration. It is highly recommended to lazy load the plugin because the Copilot server takes time to start up.

use {
  "zbirenbaum/copilot.lua",
  requires = {
    "copilotlsp-nvim/copilot-lsp", -- (optional) for NES functionality
  },
  cmd = "Copilot",
  event = "InsertEnter",
  config = function()
    require("copilot").setup({})
  end,
}

You can build integrations on top of copilot.lua using the copilot.api module. Popular existing integrations include:

• nvim-cmp: Use copilot-cmp.
• blink.cmp: Use blink-cmp-copilot or blink-copilot.
• lualine.nvim: Use copilot-lualine.

NES is an experimental feature that provides suggestions based on your likely next edit. It requires copilot-lsp as a dependency.

use {
  "zbirenbaum/copilot.lua",
  requires = {
    "copilotlsp-nvim/copilot-lsp",
    init = function()
      vim.g.copilot_nes_debounce = 500
    end,
  },
  cmd = "Copilot",
  event = "InsertEnter",
  config = function()
    require("copilot").setup({
      nes = {
        enabled = true,
        keymap = {
          accept_and_goto = "<leader>p",
          accept = false,
          dismiss = "<Esc>",
        },
      },
    })
  end,
}

You can specify which filetypes Copilot should attach to. You can use booleans, or a function that returns a boolean for fine-grained control (e.g., excluding specific filenames).

require("copilot").setup {
  filetypes = {
    markdown = true, -- overrides default
    terraform = false, -- disallow specific filetype
    sh = function ()
      if string.match(vim.fs.basename(vim.api.nvim_buf_get_name(0)), '^%.env.*') then
        -- disable for .env files
        return false
      end
      return true
    end,
  },
}