//  INSTALL

Install

A self-contained binary, a .NET tool, or a build from source.

Linux and macOS

curl -fsSL https://raw.githubusercontent.com/nickprotop/cxagent/master/install.sh | bash
cxagent

The script picks the binary matching your platform, puts it in ~/.local/bin, and adds that directory to your PATH if it is not already there. No .NET is required — the binary carries its own runtime. It also places the csharp-lsp plugin in your plugins folder and stops there: cxagent will tell you the plugin is present and wait to be told to load it. See Plugins.

Windows

irm https://raw.githubusercontent.com/nickprotop/cxagent/master/install.ps1 | iex

As a .NET tool

Requires the .NET 10 SDK or runtime. Unlike the binaries this one is framework-dependent — it uses the .NET you already have rather than carrying its own.

dotnet tool install -g cxagent
cxagent

Update it with dotnet tool update -g cxagent.

From source

Requires the .NET 10 SDK.

git clone https://github.com/nickprotop/cxagent.git
cd cxagent
./build-and-install.sh

The binaries

Every release publishes six. If you would rather not pipe a script into a shell, download the one for your platform from the latest release, make it executable, and put it somewhere on your PATH.

PlatformAsset
Linux, x64cxagent-linux-x64
Linux, ARM64cxagent-linux-arm64
macOS, Intelcxagent-osx-x64
macOS, Apple siliconcxagent-osx-arm64
Windows, x64cxagent-win-x64.exe
Windows, ARM64cxagent-win-arm64.exe

Verifying a download

Each release carries a SHA256SUMS asset, computed from the artifacts the release actually built. Fetch it from the same release as the binary and check the file you downloaded against it:

curl -fsSLO https://github.com/nickprotop/cxagent/releases/latest/download/cxagent-linux-x64
curl -fsSLO https://github.com/nickprotop/cxagent/releases/latest/download/SHA256SUMS
sha256sum --check --ignore-missing SHA256SUMS

On macOS, shasum -a 256 takes the same --check. On Windows:

Get-FileHash .\cxagent-win-x64.exe -Algorithm SHA256

and compare the value against the matching line in SHA256SUMS.

This check proves the file you downloaded is the file that release published — it catches a corrupted or truncated download. It does not prove who built it.

First run

You do not need to write any configuration to start. With no config file, or none that names a working provider, a setup wizard asks for a provider and model and writes the file for you. Provider kinds are ollama, openai-compatible and anthropic.

The file lands in ~/.config/cxagent/config.json on Linux ($XDG_CONFIG_HOME when set), %APPDATA%\cxagent\config.json on Windows, and ~/Library/Application Support/cxagent/config.json on macOS. The same directory holds your session history, logs and plugins. Every configuration key →

Uninstalling

However you installed it:

# the install script (Linux/macOS)
curl -fsSL https://raw.githubusercontent.com/nickprotop/cxagent/master/uninstall.sh | bash

# the .NET tool
dotnet tool uninstall -g cxagent
irm https://raw.githubusercontent.com/nickprotop/cxagent/master/uninstall.ps1 | iex

Your configuration and session history are left alone. They live in $XDG_CONFIG_HOME/cxagent (%APPDATA%\cxagent on Windows, ~/Library/Application Support/cxagent on macOS) — delete that directory to remove them too.