Skip to content

Installation

Install Nix if you don’t have it:

Terminal window
curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install

Adding the GHOST binary cache avoids a ~15 minute compile from source. (This step won’t be needed once GHOST lands in nixpkgs.)

If you installed Nix with the Determinate Systems installer (recommended), add to /etc/nix/nix.custom.conf:

Terminal window
echo 'extra-substituters = https://ghost-ai.cachix.org' | sudo tee -a /etc/nix/nix.custom.conf
echo 'extra-trusted-public-keys = ghost-ai.cachix.org-1:c0BYnkFKE8rYzkusZD5+l5D5Vcl8WRQMXV1zVWjxCBI=' | sudo tee -a /etc/nix/nix.custom.conf
sudo systemctl restart nix-daemon
Standard Nix (non-Determinate)

If you installed Nix via the official installer, use /etc/nix/nix.conf instead of nix.custom.conf.

NixOS

Add the cache to your system configuration:

configuration.nix
nix.settings = {
extra-substituters = [ "https://ghost-ai.cachix.org" ];
extra-trusted-public-keys = [
"ghost-ai.cachix.org-1:c0BYnkFKE8rYzkusZD5+l5D5Vcl8WRQMXV1zVWjxCBI="
];
};
  1. Install GHOST

    Terminal window
    nix profile add github:mrtolkien/GHOST/latest
  2. Run the onboarding wizard

    Terminal window
    ghost init

    The wizard configures your LLM provider, Discord bot, and all services. See Onboarding for details.

  3. Verify your setup

    Terminal window
    ghost status

    Confirms your config is valid, the daemon is running, and all services are reachable.

CommandWhat you get
nix profile add github:mrtolkien/GHOST/latestLatest release (recommended)
nix profile add github:mrtolkien/GHOST/mainBleeding edge (latest commit)
nix profile add github:mrtolkien/GHOST/v0.5.0Pinned version
Terminal window
ghost update

For development or manual setups, clone and build with Nix:

Terminal window
git clone https://github.com/mrtolkien/ghost.git
cd ghost
nix build
./result/bin/ghost version

Or install directly into your profile from a local checkout:

Terminal window
nix profile install .