diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/next/CHANGELOG.md | 1 | ||||
| -rw-r--r-- | docs/next/README.md | 14 | ||||
| -rw-r--r-- | docs/next/website/src/content/docs/install.mdx | 29 |
3 files changed, 44 insertions, 0 deletions
diff --git a/docs/next/CHANGELOG.md b/docs/next/CHANGELOG.md index f4a8a6de..de3ada07 100644 --- a/docs/next/CHANGELOG.md +++ b/docs/next/CHANGELOG.md @@ -3,6 +3,7 @@ ## Unreleased ### Added +- Added optional Nix flake support for building, running, installing, and developing Herdr with Nix. (#208, #221, #264) - Added `terminal.new_cwd` to choose whether new panes, tabs, and workspaces follow the source pane/workspace, start in `$HOME`, use Herdr's process directory, or use a fixed path. - Added `herdr integration install omp` for OMP's `.omp` extension directory. The extension reports OMP pane state through Herdr's socket API without relying on native `omp` process detection. - Added CLI and socket API support for Git worktrees with `herdr worktree list/create/open/remove`, optional worktree provenance on workspace responses, and client/server protocol version 10. diff --git a/docs/next/README.md b/docs/next/README.md index 16a9fd1c..99e99e6c 100644 --- a/docs/next/README.md +++ b/docs/next/README.md @@ -295,6 +295,20 @@ cargo build --release ./target/release/herdr ``` +## nix + +Herdr provides optional Nix flake outputs for users who already use Nix. The flake builds Herdr from source. + +```bash +nix run github:ogulcancelik/herdr +nix build github:ogulcancelik/herdr +nix develop github:ogulcancelik/herdr +``` + +The flake exposes `packages.<system>.default`, `apps.<system>.default`, `devShells.<system>.default`, and `overlays.default`. + +Update through the same Nix workflow you used to install Herdr. For profile installs, run `nix profile list` and then `nix profile upgrade <index-or-name>`. For flake inputs, run `nix flake update herdr` in your own flake and rebuild. + ## testing ```bash diff --git a/docs/next/website/src/content/docs/install.mdx b/docs/next/website/src/content/docs/install.mdx index dda2dc27..69834567 100644 --- a/docs/next/website/src/content/docs/install.mdx +++ b/docs/next/website/src/content/docs/install.mdx @@ -33,6 +33,35 @@ Herdr checks for new releases and notifies you in the app. You can update manual herdr update ``` +## Install with Nix + +If you already use Nix, Herdr provides a flake that builds Herdr from source: + +```bash +nix run github:ogulcancelik/herdr +nix build github:ogulcancelik/herdr +nix profile install github:ogulcancelik/herdr +``` + +The flake also exposes a development shell: + +```bash +nix develop github:ogulcancelik/herdr +``` + +Update through the same Nix workflow you used to install Herdr. For a profile install, list your profile entries and upgrade the Herdr entry: + +```bash +nix profile list +nix profile upgrade <index-or-name> +``` + +If Herdr is an input in your own flake, update that input and rebuild your system, Home Manager, or development environment: + +```bash +nix flake update herdr +``` + ## Download manually You can also download a binary from [GitHub releases](https://github.com/ogulcancelik/herdr/releases). |