From c50f78af38d1f4829fdc572958cd172f99aea808 Mon Sep 17 00:00:00 2001 From: eiei114 <60887155+eiei114@users.noreply.github.com> Date: Sat, 24 Oct 2026 01:01:06 +0900 Subject: [PATCH 1/2] docs: document installing robcli through Rokit robcli already ships the archives Rokit needs, but the README only described crates.io and manual extraction, so the cheapest install path was undocumented. Add the rokit.toml snippet, and record the three things a reader would otherwise hit as surprises: - Rokit requires an exact version; `^0.8` is rejected. - Rokit 1.2.0 validates the OS of the downloaded binary but not its architecture, so an Intel Mac installs macos-aarch64, reports success, and then cannot exec `rob`. Point at the source build. - Rokit 1.2.0 does not read the `.sha256` sidecar, so don't imply it verifies. Also note that the archive member is `rob` while the repository is `robcli`, so member selection uses Rokit's scoring fallback rather than an exact filename match. Verified against rokit 1.2.0: tool-storage holds `robcli.exe`, the alias link is `rob.exe`, and `rob --version` prints 0.8.0. --- readme.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/readme.md b/readme.md index 2575357..ff1cf93 100644 --- a/readme.md +++ b/readme.md @@ -134,6 +134,44 @@ credential-like argument values are not echoed. Help/version remain human-readab ## Install +### Pin the version with Rokit (recommended for Roblox projects) + +[Rokit](https://github.com/rojo-rbx/rokit) installs a prebuilt binary from the +GitHub Release, so there is no Rust toolchain and no native C build environment +to set up. Pin it next to the rest of the Roblox toolchain: + +```toml +# rokit.toml +[tools] +rojo = "rojo-rbx/rojo@7.7.1" +rob = "eiei114/robcli@0.8.0" +``` + +```bash +rokit install +rob --version +``` + +Rokit's `aftman.toml` and `foreman.toml` compatibility also works. Rokit +requires an **exact** version; a requirement like `^0.8` is rejected. + +The manifest key is the alias and decides the command name, so `rob = ...` is +what keeps the executable `rob`. Rokit picks the archive by scanning the asset +name for an OS and an architecture. The archive member is `rob` while the +repository is `robcli`, so the final member lookup falls back to scoring +executable suffix and contents instead of an exact filename match. Installation +works today; matching the repository name would remove that fallback. + +> [!warning] Intel Macs +> There is no `macos-x86_64` archive. Rokit 1.2.0 checks the operating system +> of the downloaded binary but **not** its architecture, so on an Intel Mac +> `rokit install` reports success and `rob --version` then fails to execute. +> Use the source build below instead, or omit `rob` from the manifest there. + +**Rokit 1.2.0 does not read the `.sha256` sidecar.** If you need integrity +beyond a pinned version, a GitHub Release, and Rokit's own trust prompt, +verify the digest yourself as shown under the release archive section. + ### From crates.io ```bash From 46777726d35ee4b68e6e9600f5ca3ff6d776f188 Mon Sep 17 00:00:00 2001 From: eiei114 <60887155+eiei114@users.noreply.github.com> Date: Sat, 24 Oct 2026 01:08:57 +0900 Subject: [PATCH 2/2] docs: name the Windows archive member correctly The release matrix packs rob.exe on Windows and rob on Linux/macOS, so describing the member as always `rob` made the fallback explanation wrong on Windows. Verified against the published v0.8.0 zip: the member is rob.exe. --- readme.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/readme.md b/readme.md index ff1cf93..0181474 100644 --- a/readme.md +++ b/readme.md @@ -157,10 +157,11 @@ requires an **exact** version; a requirement like `^0.8` is rejected. The manifest key is the alias and decides the command name, so `rob = ...` is what keeps the executable `rob`. Rokit picks the archive by scanning the asset -name for an OS and an architecture. The archive member is `rob` while the -repository is `robcli`, so the final member lookup falls back to scoring -executable suffix and contents instead of an exact filename match. Installation -works today; matching the repository name would remove that fallback. +name for an OS and an architecture. The archive member is `rob.exe` on Windows +and `rob` on Linux/macOS. Because the repository is `robcli`, the final member +lookup falls back to scoring the executable suffix and contents instead of an +exact filename match. Installation works today; matching the repository name +would remove that fallback. > [!warning] Intel Macs > There is no `macos-x86_64` archive. Rokit 1.2.0 checks the operating system