ACP (Editor Integrations)

Shux implements the Agent Client Protocol (ACP) to integrate with editors that support it. The shux acp command starts a stdio bridge that any ACP-compatible editor can spawn as a subprocess.

ACP is the “LSP for agents” and provides session management, tool delegation, and streaming. Shux uses ACP (not MCP) for its editor bridge.

Zed

Zed has native ACP support and does not require a plugin. Open Settings (Cmd+,) and add:

{
  "agent_servers": {
    "Shux": {
      "type": "custom",
      "command": "shux",
      "args": ["acp"]
    }
  }
}

Using npx (no global install)

{
  "agent_servers": {
    "Shux": {
      "type": "custom",
      "command": "npx",
      "args": ["-y", "@coder/shux", "acp"]
    }
  }
}

Connect to a remote server

Pass --server-url and --auth-token in args:

{
  "agent_servers": {
    "Shux": {
      "type": "custom",
      "command": "shux",
      "args": ["acp", "--server-url", "https://shux.example.com", "--auth-token", "<token>"]
    }
  }
}

Or set environment variables for any shux acp process:

SHUX_SERVER_URL=https://shux.example.com \
SHUX_SERVER_AUTH_TOKEN=<token> \
shux acp

Neovim

Two plugins currently support ACP in Neovim.

codecompanion.nvim (recommended)

codecompanion.nvim added ACP support in v17.18. Add the adapter in your lazy.nvim config:

require("codecompanion").setup({
  adapters = {
    shux = function()
      return require("codecompanion.adapters").extend("acp", {
        name = "shux",
        schema = {
          model = { default = "shux" },
        },
        args = { "shux", "acp" },
      })
    end,
  },
  strategies = {
    chat = { adapter = "shux" },
    inline = { adapter = "shux" },
  },
})

See the codecompanion ACP adapter docs for full options.

agentic.nvim

agentic.nvim is a dedicated ACP client. Requires Neovim 0.11 or newer. Add via lazy.nvim:

{
  "carlos-algms/agentic.nvim",
  opts = {
    agents = {
      shux = {
        cmd = "shux",
        args = { "acp" },
      },
    },
  },
}

JetBrains

JetBrains ACP support requires the AI Assistant plugin (2025.3 or newer).

Open the AI Chat tool window
Click More (...) then Add Custom Agent
Add the Shux entry to the acp.json that opens:

{
  "agent_servers": {
    "Shux": {
      "command": "shux",
      "args": ["acp"]
    }
  }
}

ACP is not supported in WSL-backed JetBrains projects.

See the JetBrains ACP docs for more information.

Flags and environment variables

Flag	Environment variable	Description
`--server-url <url>`	`SHUX_SERVER_URL`	URL of a running Shux server
`--auth-token <token>`	`SHUX_SERVER_AUTH_TOKEN`	Bearer token for authenticated connections
`--log-file <path>`	—	Write ACP logs to a file (useful when your editor hides subprocess stderr)

SHUX_AUTH_TOKEN is not read by shux acp. Use SHUX_SERVER_AUTH_TOKEN.

If no --server-url is provided, shux acp first attempts to discover a running server via the lockfile in ~/.shux/, then starts an in-process server automatically when needed.

Troubleshooting

Logs hidden by your editor: use --log-file /tmp/shux-acp.log to capture ACP stderr output.
Connection refused: ensure Shux is running (shux server or the desktop app), or omit --server-url to let ACP auto-start in-process.
Tool calls are not delegated: the editor must advertise filesystem or terminal capabilities, and the workspace must use local runtime mode.

Getting Started

Workspaces

Agents

Configuration

Guides

Integrations

Reference

ACP (Editor Integrations)

Zed

Connect to a remote server

Neovim

codecompanion.nvim (recommended)

agentic.nvim

JetBrains

Flags and environment variables

Troubleshooting

​Zed

​Connect to a remote server

​Neovim

​codecompanion.nvim (recommended)

​agentic.nvim

​JetBrains

​Flags and environment variables

​Troubleshooting

​Related

Zed

Connect to a remote server

Neovim

codecompanion.nvim (recommended)

agentic.nvim

JetBrains

Flags and environment variables

Troubleshooting

Related