diff options
Diffstat (limited to 'website/src/content/docs/install.mdx')
| -rw-r--r-- | website/src/content/docs/install.mdx | 32 |
1 files changed, 24 insertions, 8 deletions
diff --git a/website/src/content/docs/install.mdx b/website/src/content/docs/install.mdx index c23ffee8..e64e9c7d 100644 --- a/website/src/content/docs/install.mdx +++ b/website/src/content/docs/install.mdx @@ -1,19 +1,25 @@ --- title: Install Herdr -description: Install, update, and verify Herdr on Linux and macOS. +description: Install, update, and verify Herdr on Linux, macOS, and Windows beta. --- -Herdr ships as a single binary for Linux and macOS. +Herdr ships stable binaries for Linux and macOS. Native Windows support is preview-only beta. ## Install -Run the installer: +On Linux or macOS, run: ```bash curl -fsSL https://herdr.dev/install.sh | sh ``` -The installer downloads the right release binary for your platform and places it on your PATH. +On Windows preview beta, install the preview channel: + +```powershell +powershell -ExecutionPolicy Bypass -c "irm https://herdr.dev/install.ps1 | iex" +``` + +The installer downloads the right release binary for your platform and places it on your PATH. The Windows installer defaults to preview, writes that channel to Herdr's config, uses versioned install folders, and updates a `current` junction, so updates do not need to overwrite a running `herdr.exe`. ## Install with Homebrew @@ -53,13 +59,13 @@ herdr update `herdr update` is for installs managed by Herdr's own installer. Homebrew, mise, and Nix installs are updated through those package managers instead. -Herdr uses the stable update channel by default. To opt into preview builds from `master`, set the channel: +On Linux and macOS, Herdr uses the stable update channel by default. To opt into preview builds from `master`, set the channel: ```bash herdr channel set preview ``` -Switch back to stable the same way: +Switch Linux and macOS direct installs back to stable the same way: ```bash herdr channel set stable @@ -69,6 +75,8 @@ For direct installs, changing channels also checks that channel and installs its Preview builds are GitHub prereleases published from the current development branch. They are useful when you want fixes before the next stable release, but they can regress. Homebrew, mise, and Nix installs do not use the preview channel. +Windows beta builds are preview-only for now. `herdr channel set stable` is rejected on Windows until stable Windows releases are available. + By default, `herdr update` installs the new binary and leaves compatible running sessions alone. If an update changes Herdr's client/server protocol, Herdr asks whether to stop the old server after installing. Stop the old server to use the new version. Stopping exits pane processes. For the default session, run `herdr server stop`, then run `herdr` again. For a named session, run `herdr session stop <name>`, then run `herdr session attach <name>` again. To opt into experimental live server handoff for supported running sessions, run: @@ -123,13 +131,21 @@ Choose the asset that matches your system: | macOS Intel | `herdr-macos-x86_64` | | macOS Apple silicon | `herdr-macos-aarch64` | -Make it executable and move it somewhere on your PATH. +On Linux or macOS, make it executable and move it somewhere on your PATH. ```bash chmod +x herdr-linux-x86_64 mv herdr-linux-x86_64 ~/.local/bin/herdr ``` +### Windows beta downloads + +Windows binaries are published only on preview releases while native Windows support is in beta. Use the preview installer above for normal testing, or download the Windows asset from a preview GitHub prerelease: + +| System | Asset | +| --- | --- | +| Windows x86_64 beta | `herdr-windows-x86_64.exe` | + ## Requirements -Stable Herdr releases support Linux and macOS. Native Windows builds are preview-only beta releases; stable users on Windows should use Herdr inside WSL for now. +Stable Herdr releases support Linux and macOS. Native Windows builds are preview-only beta releases; see [Windows beta](/docs/windows-beta/) for supported workflows and known limitations. |
