docs: explain GitHub release asset naming in README#598
docs: explain GitHub release asset naming in README#598Olusammytee wants to merge 2 commits intoKilo-Org:devfrom
Conversation
Code Review SummaryStatus: 4 Issues Found | Recommendation: Address before merge Overview
Issue Details (click to expand)WARNING
Files Reviewed (1 file)
|
There was a problem hiding this comment.
Pull request overview
Adds README guidance to help users choose the correct GitHub Release asset for installing the Kilo CLI, addressing confusion called out in issue #561.
Changes:
- Adds a “Install from GitHub Releases (Optional)” section under the CLI getting-started instructions.
- Explains common OS/arch naming conventions and distinguishes CLI binaries from VS Code
.vsixassets and source archives. - Provides quick “most users” download recommendations by platform.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| If you prefer downloading a binary from the [Releases page](https://github.com/Kilo-Org/kilo/releases), use this quick guide: | ||
|
|
||
| - `kilo-<os>-<arch>.zip` is the CLI binary for your OS and CPU architecture. |
There was a problem hiding this comment.
The release archives are not always .zip. The build script produces .tar.gz archives for Linux targets (and .zip for non-Linux), so this line will mislead Linux users. Consider documenting the extension as platform-dependent (e.g., .zip on macOS/Windows, .tar.gz on Linux).
README.md
Outdated
| - `kilo-<os>-<arch>.zip` is the CLI binary for your OS and CPU architecture. | ||
| - `darwin` means macOS. | ||
| - `x64` is standard 64-bit Intel/AMD CPUs. | ||
| - `x64_baseline` is a compatibility build for older CPUs that may not support newer instruction sets. |
There was a problem hiding this comment.
The naming here doesn’t match the actual release artifact names generated by the build scripts: the compatibility build uses a -baseline suffix (hyphen), not x64_baseline (underscore). To avoid broken guidance, please align this with the published asset naming (e.g., kilo-<os>-<arch>-baseline).
| - `kilo-<os>-<arch>.zip` is the CLI binary for your OS and CPU architecture. | |
| - `darwin` means macOS. | |
| - `x64` is standard 64-bit Intel/AMD CPUs. | |
| - `x64_baseline` is a compatibility build for older CPUs that may not support newer instruction sets. | |
| - `kilo-<os>-<arch>[-baseline].zip` is the CLI binary for your OS and CPU architecture. | |
| - `darwin` means macOS. | |
| - `x64` is standard 64-bit Intel/AMD CPUs. | |
| - `-baseline` indicates a compatibility build for older CPUs that may not support newer instruction sets. |
| - `kilo-<os>-<arch>.zip` is the CLI binary for your OS and CPU architecture. | ||
| - `darwin` means macOS. | ||
| - `x64` is standard 64-bit Intel/AMD CPUs. | ||
| - `x64_baseline` is a compatibility build for older CPUs that may not support newer instruction sets. | ||
| - `arm64` is Apple Silicon (M1/M2/M3) or ARM-based Linux/Windows. | ||
| - `kilo-vscode-*.vsix` is the VS Code extension package (not the CLI binary). | ||
| - `Source code` archives are for building from source, not normal installation. | ||
|
|
||
| For most users: | ||
|
|
||
| - **Windows (most PCs):** `kilo-windows-x64.zip` | ||
| - **Windows on ARM:** `kilo-windows-arm64.zip` | ||
| - **macOS Apple Silicon:** `kilo-darwin-arm64.zip` | ||
| - **macOS Intel:** `kilo-darwin-x64.zip` | ||
| - **Linux x64:** `kilo-linux-x64.zip` |
There was a problem hiding this comment.
These example filenames don’t match what the release process produces: Linux artifacts are uploaded as .tar.gz (e.g., kilo-linux-x64.tar.gz), and there is no Windows ARM64 build target in the current CLI build matrix. Please update the examples to reflect the actual published assets (and, if Windows ARM isn’t supported, say so explicitly).
| - `kilo-<os>-<arch>.zip` is the CLI binary for your OS and CPU architecture. | |
| - `darwin` means macOS. | |
| - `x64` is standard 64-bit Intel/AMD CPUs. | |
| - `x64_baseline` is a compatibility build for older CPUs that may not support newer instruction sets. | |
| - `arm64` is Apple Silicon (M1/M2/M3) or ARM-based Linux/Windows. | |
| - `kilo-vscode-*.vsix` is the VS Code extension package (not the CLI binary). | |
| - `Source code` archives are for building from source, not normal installation. | |
| For most users: | |
| - **Windows (most PCs):** `kilo-windows-x64.zip` | |
| - **Windows on ARM:** `kilo-windows-arm64.zip` | |
| - **macOS Apple Silicon:** `kilo-darwin-arm64.zip` | |
| - **macOS Intel:** `kilo-darwin-x64.zip` | |
| - **Linux x64:** `kilo-linux-x64.zip` | |
| - `kilo-<os>-<arch>.zip` is the CLI binary for your OS and CPU architecture on Windows and macOS. On Linux, binaries are published as `kilo-<os>-<arch>.tar.gz`. | |
| - `darwin` means macOS. | |
| - `x64` is standard 64-bit Intel/AMD CPUs. | |
| - `x64_baseline` is a compatibility build for older CPUs that may not support newer instruction sets. | |
| - `arm64` is Apple Silicon (M1/M2/M3) or ARM-based Linux. | |
| - `kilo-vscode-*.vsix` is the VS Code extension package (not the CLI binary). | |
| - `Source code` archives are for building from source, not normal installation. | |
| For most users: | |
| - **Windows (most PCs):** `kilo-windows-x64.zip` | |
| - **Windows on ARM:** Native Windows ARM builds are not currently published. If supported by your system, you may run the x64 build under emulation. | |
| - **macOS Apple Silicon:** `kilo-darwin-arm64.zip` | |
| - **macOS Intel:** `kilo-darwin-x64.zip` | |
| - **Linux x64:** `kilo-linux-x64.tar.gz` |
|
CI note: this PR is docs-only (README.md), and the failing e2e (windows) job appears infrastructure-related (Bun crash in the runner). The downstream est (linux) failed because it depends on that failed e2e job. I don’t have permission to rerun failed jobs on this repo (Must have admin rights). |
|
Pushed a small docs wording cleanup commit (x64_baseline description) to trigger a fresh CI run. |
![kiloconnect[bot]](https://avatars.githubusercontent.com/in/2193792?s=60&v=4){kind=small}
| - `darwin` means macOS. | ||
| - `x64` is standard 64-bit Intel/AMD CPUs. | ||
| - `x64_baseline` is a compatibility build for older x64 CPUs that may not support newer instruction sets. | ||
| - `arm64` is Apple Silicon (M1/M2/M3) or ARM-based Linux/Windows. |
There was a problem hiding this comment.
WARNING: The build matrix does not include a Windows ARM64 target (win32 + arm64 is absent from allTargets in build.ts). Mentioning "ARM-based … Windows" here will confuse users looking for a kilo-windows-arm64 binary that doesn't exist.
| - `arm64` is Apple Silicon (M1/M2/M3) or ARM-based Linux/Windows. | |
| - `arm64` is Apple Silicon (M1/M2/M3) or ARM-based Linux. |
1 participant
Summary\n- add a release asset selection section to README\n- explain darwin, x64, x64_baseline, and �rm64 naming\n- clarify that .vsix files are VS Code extension packages and source archives are for building from source\n- include quick OS/architecture download guidance for common platforms\n\n## Testing\n- docs-only change\n\nFixes #561