Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Install

After installation, don't forget to do setup!

Cargo (Universal)

cargo install lacy

Homebrew (macOS/Linux)

brew install timothebot/tap/lacy

NixOS ❄️

There are a couple of ways to get lacy up and running on your Nix system. Both methods require adding lacy to your flake.nix inputs.

# flake.nix
{
  inputs = {
    lacy.url = "github:timothebot/lacy";
    # ... other inputs
  };

  outputs = { self, nixpkgs, lacy, ... }@inputs: {
    # ...
  };
}

This is the easiest way to manage lacy if you're using Home Manager. The module handles most of the setup for you. You must explicitly add the lacy flake as an overlay to your configuration to ensure the lacy package is available.

# home.nix
{ pkgs, inputs, ... }: {
  # Explicitly add the overlay to make lacy visible in your pkgs set
  nixpkgs.overlays = [ inputs.lacy.overlays.default ];

  imports = [
    inputs.lacy.homeManagerModules.default
  ];

  programs.lacy.enable = true;
}

2. Nix Overlay (NixOS / Home Manager)

If you prefer to manage packages directly without using the Home Manager module, this is the way to go. You apply the overlay and then add the lacy package to your system or user packages.

For NixOS

# In your NixOS configuration (e.g., /etc/nixos/configuration.nix)
{ pkgs, inputs, ... }: {
  nixpkgs.overlays = [ inputs.lacy.overlays.default ];

  environment.systemPackages = [ pkgs.lacy ];
}

For Home Manager

# In your home-manager configuration (e.g., ~/.config/nixpkgs/home.nix)
{ pkgs, inputs, ... }: {
  nixpkgs.overlays = [ inputs.lacy.overlays.default ];

  home.packages = [ pkgs.lacy ];
}

3. Run lacy directly

Just want to try it out? You can run lacy from the command line without adding it to your system configuration.

nix run github:timothebot/lacy