Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.augmentcode.com/llms.txt

Use this file to discover all available pages before exploring further.

​
About ACP Clients

Agent Client Protocol (ACP) is an open protocol that provides a standardized way to connect AI agents to different text editors, IDEs, and other tools. Auggie is a fully ACP compatible agent enabling you to bring the power of Augment to editors like Zed, Neovim, or Emacs. See a full list of supported clients in the ACP docs.

​
Prerequisites

​
Client configuration

If you have an ACP client that you would like to have listed here, please open an issue and we’ll be happy to add it.

​
Zed

We recommend installing and configuring Auggie in Zed using the Auggie extension.
If you want to configure Auggie manually through Zed’s settings, you can use the following configuration. You can pass additional command-line arguments to Auggie by adding them to the args array or use alternative authentication methods by passing environment variables in the env object. 
{
  "agent_servers": {
    "Auggie CLI": {
      "command": "auggie",
      "args": ["--acp"],
      "env": {}
    }
  }
}

​
JetBrains

We recommend installing and configuring Augment in JetBrains IDEs using the Augment extension.
To use Auggie with JetBrains IDEs, you can configure it in your IDE settings. You can pass additional command-line arguments to Auggie by adding them to the args array or use alternative authentication methods by passing environment variables in the env object. 
{
  "agent_servers": {
    "Auggie CLI": {
      "command": "auggie",
      "args": [
        "--acp"
      ],
      "env": {}
    }
  }
}

​
Neovim

To use Auggie with Neovim, you can use one of the following plugins:

​
Avante.nvim

Add the following to your lazy.nvim configuration: 
  {
    "yetone/avante.nvim",
    event = "VeryLazy",
    build = "make",
    dependencies = {
      "nvim-lua/plenary.nvim",
      "MunifTanjim/nui.nvim",
    },
    opts = {
      provider = "auggie-acp",
      acp_providers = {
        ["auggie-acp"] = {
          command = "auggie",
          args = { "--acp" },
        },
      },
      behaviour = {
        auto_suggestions = false,
        auto_set_highlight_group = true,
        auto_set_keymaps = true,
        auto_apply_diff_after_generation = false,
        support_paste_from_clipboard = false,
      },
    },
  },

​
Agentic.nvim

Add the following to your lazy.nvim configuration: 
{
  "carlos-algms/agentic.nvim",
  opts = {
    provider = "auggie-acp",
    acp_providers = {
      ["auggie-acp"] = {
        command = "auggie",
        args = { "--acp" },
      },
    },
  },
}

​
CodeCompanion.nvim

Add the following to your lazy.nvim configuration: 
{
  "olimorris/codecompanion.nvim",
  opts = {
    strategies = {
      chat = {
        adapter = "auggie_cli",
      },
      inline = {
        adapter = "auggie_cli",
      },
    },
  },
}

​
Emacs

To use Auggie with emacs, you can use one of the following plugins: