Skip to content

Installation

The installer sets up the ix CLI and everything it needs. All you need beforehand is a terminal with curl or wget.

Terminal window
curl -fsSL https://ix-infra.com/install.sh | sh

Pre-built CLI packages are published for Apple Silicon macOS, Linux (x86-64 and arm64) and Windows x86-64.

The installer checks for each of these and installs anything missing:

Component Why Ix needs it
Node.js 22+ Runs the ix CLI
Git Workspace detection
ripgrep Powers ix text. Optional: a failed install only prints a warning
Docker + Docker Compose Runs the local backend

The backend is two containers. Only the memory layer has a host port, and it binds to localhost:

  • Ix Memory Layer, the HTTP API the CLI talks to, on 127.0.0.1:8090
  • ArangoDB 3.12, the graph database, with no host port: only the memory layer reaches it, over the Compose network
Terminal window
ix --version # the CLI is on your PATH
ix status # the backend is reachable
ix doctor # server, database and graph integrity

If ix status reports Ix backend not reachable, start the backend with ix docker start. See Troubleshooting for other first-run problems.

Path Contents
~/.ix/ Ix home directory. Override with $IX_HOME
~/.ix/config.yaml CLI configuration
~/.ix/backend/ Docker Compose file for the local backend
~/.ix/cli/ Installed CLI and its dependencies
/usr/local/bin/ix or ~/.local/bin/ix The ix wrapper, in whichever is writable

The complete list, including every network endpoint the installer contacts, is in docs/prerequisites.md.

Terminal window
ix upgrade --check # see whether an update is available
ix upgrade # upgrade the CLI, backend and components