Request early access

Docs

Install Grixel

Grixel ships as prebuilt binaries for macOS and Linux. You install them from the Grixel distribution repository and then sign in to your team's server.

#1. Get the tools

Clone the distribution repository and run the installer:

git clone https://github.com/unabated-games/grixel-dist.git
sh grixel-dist/install.sh

That installs three programs to ~/.local/bin:

  • grixel — the command-line tool you'll use day to day.
  • grixel-mcp — the connector that lets AI assistants read your project.
  • grixeld — the server. You only need this if you run the server yourself; if so, see Running a server.

Options:

sh install.sh --system            # install to /usr/local/bin instead (may ask for sudo)
sh install.sh --version vX.Y.Z    # install a specific version

If the installer says ~/.local/bin isn't on your PATH, follow the printed hint to add it, then open a new terminal.

The distribution repository is private, so the installer needs to authenticate. The simplest way is to have the GitHub CLI installed and signed in (gh auth login). Alternatively, set GH_TOKEN to a token that can read the repository before running the installer.

Check it worked:

grixel version

#2. Sign in

Your administrator gives you a server address and a token. Sign in once:

grixel login -server grpc://your-grixel-server:8090 -token <your-token>

After that, every command uses your saved sign-in automatically. Confirm who you are and where you're connected:

grixel whoami

#Updating

Re-run the installer to move to the latest version:

sh grixel-dist/install.sh

#Next

Head to Getting started to make your first change.