starred/herdr
1
0
Fork 0
mirror of https://github.com/herdrdev/herdr.git synced 2026-09-21 16:01:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: document windows preview installs

Browse Source
This commit is contained in:
Ogulcan Celik
2026-06-07 19:55:44 +03:00
parent c01b947d0b
commit 970c07ea31
8 changed files with 137 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/next/README.md
+2 -2
View File
@@ -25,7 +25,7 @@ workspaces, tabs, panes. mouse-native: click, drag, split. every agent at a glan
curl -fsSL https://herdr.dev/install.sh | sh
```
on windows beta:
on windows preview beta:
```powershell
$env:HERDR_CHANNEL="preview"; powershell -ExecutionPolicy Bypass -c "irm https://herdr.dev/install.ps1 | iex"
@@ -43,7 +43,7 @@ or install with mise:
mise use -g herdr
```
or download the binary from [releases](https://github.com/ogulcancelik/herdr/releases). native windows support is beta.
or download the stable Linux/macOS binary from [releases](https://github.com/ogulcancelik/herdr/releases). Native Windows binaries are preview-only beta builds.
## quick start
docs/next/website/src/content/docs/index.mdx
+2 -2
View File
@@ -23,7 +23,7 @@ curl -fsSL https://herdr.dev/install.sh | sh
herdr
```
On Windows beta:
On Windows preview beta:
```powershell
$env:HERDR_CHANNEL="preview"; powershell -ExecutionPolicy Bypass -c "irm https://herdr.dev/install.ps1 | iex"
@@ -34,7 +34,7 @@ herdr
<CardGrid>
<Card title="Install">
Install Herdr on Linux, macOS, or Windows beta, update it later, and verify the binary.
Install stable Herdr on Linux/macOS or the Windows preview beta, update it later, and verify the binary.
[Install Herdr →](/docs/install/)
</Card>
docs/next/website/src/content/docs/install.mdx
+11 -4
View File
@@ -3,7 +3,7 @@ title: Install Herdr
description: Install, update, and verify Herdr on Linux, macOS, and Windows beta.
---
Herdr ships as a single binary for Linux and macOS. Native Windows support is beta.
Herdr ships stable binaries for Linux and macOS. Native Windows support is preview-only beta.
## Install
@@ -13,7 +13,7 @@ On Linux or macOS, run:
curl -fsSL https://herdr.dev/install.sh | sh
```
On Windows beta, install the preview channel:
On Windows preview beta, install the preview channel:
```powershell
$env:HERDR_CHANNEL="preview"; powershell -ExecutionPolicy Bypass -c "irm https://herdr.dev/install.ps1 | iex"
@@ -126,7 +126,6 @@ Choose the asset that matches your system:
| Linux aarch64 | `herdr-linux-aarch64` |
| macOS Intel | `herdr-macos-x86_64` |
| macOS Apple silicon | `herdr-macos-aarch64` |
| Windows x86_64 beta | `herdr-windows-x86_64.exe` |
On Linux or macOS, make it executable and move it somewhere on your PATH.
@@ -135,6 +134,14 @@ 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
Herdr supports Linux and macOS. Native Windows support is beta; see [Windows beta](/docs/windows-beta/) for supported workflows and known limitations.
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.
docs/next/website/src/content/docs/windows-beta.mdx
+12 -2
View File
@@ -3,7 +3,11 @@ title: Windows beta
description: Native Windows support status, supported workflows, and known limitations.
---
Native Windows support is beta. It runs as the same Herdr version as Linux and macOS, but some Unix features are intentionally unavailable on Windows.
Native Windows support is experimental beta.
Herdr on Windows uses ConPTY and Windows process/runtime behavior instead of the Unix PTY model Herdr was originally built around. Some Herdr features map cleanly to Windows, and some do not. This preview is not a commitment that every Linux/macOS feature will become fully supported on Windows.
The goal of the beta is to learn from real use: install success, pane reliability, agent workflows, bug volume, missing features, and whether Windows users are getting enough value from Herdr. Based on that feedback, Windows support may graduate to stable, stay preview-only while it matures, or be reduced if the maintenance cost is not justified.
Install native Windows beta builds with PowerShell:
@@ -11,7 +15,7 @@ Install native Windows beta builds with PowerShell:
$env:HERDR_CHANNEL="preview"; powershell -ExecutionPolicy Bypass -c "irm https://herdr.dev/install.ps1 | iex"
```
Windows beta builds ship through the preview channel first. The Windows installer stores releases under `%USERPROFILE%\.herdr\packages\standalone\releases`, points `%LOCALAPPDATA%\Programs\Herdr\bin` at the current release, and keeps a small number of older releases so running processes do not block updates.
Windows beta builds ship only through the preview channel. The Windows installer stores releases under `%USERPROFILE%\.herdr\packages\standalone\releases`, points `%LOCALAPPDATA%\Programs\Herdr\bin` at the current release, and keeps a small number of older releases so running processes do not block updates.
For internal beta testing, `HERDR_MANIFEST_URL` can point the installer at a custom manifest instead of Herdr's stable or preview manifest.
@@ -50,6 +54,12 @@ Windows Terminal may support image paste paths for specific agents, but Herdr's
Kitty graphics remains experimental and is not claimed as Windows-supported yet. Leave `experimental.kitty_graphics = false` unless you are specifically testing image rendering in Windows Terminal.
## Copy and paste
Herdr's pane text copy works on Windows beta. Drag-select text inside a pane to copy through Herdr.
For paste, use `ctrl+shift+v` in Windows Terminal, or hold `shift` and right-click to use the outer terminal paste action instead of sending the click through Herdr.
## Not supported on Windows beta
| Capability | Status |
website/css/style.css
+48
View File
@@ -1120,6 +1120,54 @@ samp {
color: var(--accent);
}
.windows-install {
margin-top: 0.85rem;
padding-top: 0.85rem;
border-top: 1px solid var(--line);
}
.windows-install-heading {
display: flex;
align-items: center;
justify-content: space-between;
gap: 0.75rem;
color: var(--muted);
font-family: var(--mono);
font-size: 0.72rem;
font-weight: 600;
}
.windows-install-heading span {
color: var(--ink-soft);
}
.windows-install-heading a {
color: var(--accent);
text-decoration: none;
}
.windows-install-heading a:hover {
text-decoration: underline;
}
.install-card-secondary {
margin-top: 0.45rem;
background: color-mix(in srgb, var(--term-bg) 82%, transparent);
}
.install-card-secondary .prompt {
font-size: 0.72rem;
}
.install-card-secondary code {
font-size: 0.68rem;
}
.install-card-secondary button {
padding: 0.24rem 0.55rem;
font-size: 0.68rem;
}
.hero-note {
margin: 0.75rem 0 0;
color: var(--muted-2);
website/index.html
+33 -15
View File
@@ -137,7 +137,7 @@
</div>
<div class="install-panel" aria-label="Install options">
<div class="install-methods" role="group" aria-label="Install method">
<span class="install-label">Install with</span>
<span class="install-label">Stable install</span>
<button
class="install-method is-active"
type="button"
@@ -165,10 +165,23 @@
<code id="install-cmd" class="is-compact"
>curl -fsSL https://herdr.dev/install.sh | sh</code
>
<button id="copy-btn" type="button">Copy</button>
<button id="copy-btn" type="button" data-copy-target="install-cmd">Copy</button>
</div>
<div class="windows-install" aria-label="Windows beta preview install">
<div class="windows-install-heading">
<span>Windows beta · preview only</span>
<a href="/docs/preview/windows-beta/">Preview docs</a>
</div>
<div class="install-card install-card-secondary" aria-label="Windows beta install command">
<span class="prompt">PS&gt;</span>
<code id="windows-install-cmd" class="is-compact"
>$env:HERDR_CHANNEL="preview"; irm https://herdr.dev/install.ps1 | iex</code
>
<button type="button" data-copy-target="windows-install-cmd">Copy</button>
</div>
</div>
</div>
<p class="hero-note">Single Rust binary · no Electron</p>
<p class="hero-note">Stable Linux/macOS · Windows preview beta · no Electron</p>
</div>
</div>
@@ -1048,18 +1061,23 @@ $ herdr</code></pre>
});
});
copyButton.addEventListener("click", async function () {
try {
await navigator.clipboard.writeText(
command.textContent.trim(),
);
copyButton.textContent = "Copied";
setTimeout(function () {
copyButton.textContent = "Copy";
}, 1500);
} catch (error) {
copyButton.textContent = "Select";
}
document.querySelectorAll("[data-copy-target]").forEach(function (button) {
button.addEventListener("click", async function () {
var target = document.getElementById(button.dataset.copyTarget);
if (!target) return;
try {
await navigator.clipboard.writeText(
target.textContent.trim(),
);
button.textContent = "Copied";
setTimeout(function () {
button.textContent = "Copy";
}, 1500);
} catch (error) {
button.textContent = "Select";
}
});
});
})();
website/src/components/Sidebar.astro
+28 -1
View File
@@ -6,7 +6,34 @@ import SidebarSublist from '@astrojs/starlight/components/SidebarSublist.astro';
const { sidebar } = Astro.locals.starlightRoute;
const pathname = Astro.url.pathname;
const isPreview = pathname === '/docs/preview/' || pathname.startsWith('/docs/preview/');
const channelSidebar = isPreview ? rewriteSidebar(sidebar) : sidebar;
const channelSidebar = isPreview ? addPreviewOnlyItems(rewriteSidebar(sidebar)) : sidebar;
function addPreviewOnlyItems(entries) {
return entries.map((entry) => {
if (entry.type !== 'group' || entry.label !== 'Start here') return entry;
const windowsBeta = {
type: 'link',
label: 'Windows beta',
href: '/docs/preview/windows-beta/',
badge: undefined,
isCurrent: samePath('/docs/preview/windows-beta/', pathname),
attrs: {},
};
const nextEntries = [];
for (const child of entry.entries) {
nextEntries.push(child);
if (child.type === 'link' && child.label === 'Install') {
nextEntries.push(windowsBeta);
}
}
return {
...entry,
entries: nextEntries,
};
});
}
function rewriteSidebar(entries) {
return entries.map((entry) => {
website/src/content/docs/install.mdx
+1 -1
View File
@@ -130,4 +130,4 @@ mv herdr-linux-x86_64 ~/.local/bin/herdr
## Requirements
Herdr supports Linux and macOS. Native Windows support is not available yet; use Herdr inside WSL for now.
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.