@onebrain-ai/cli 3.1.3 → 3.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +28 -42
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -5,64 +5,50 @@ npm wrapper for the [OneBrain CLI](https://github.com/onebrain-ai/onebrain-cli)
5
5
  ```bash
6
6
  npm install -g @onebrain-ai/cli
7
7
  onebrain --version
8
- # → onebrain 3.0.0
9
8
  ```
10
9
 
11
- ## What this package does
10
+ > **This package is a thin installer.** On install, `postinstall.js` downloads the matching platform-native binary from the corresponding [GitHub Release](https://github.com/onebrain-ai/onebrain-cli/releases), verifies its SHA-256, and stages it at `./bin/onebrain` (`onebrain.exe` on Windows); the `onebrain` command is a small Node shim that execs the native binary.
11
+ >
12
+ > 📖 **Full documentation** — install paths, the command tree, output modes, architecture, and roadmap — lives in the **[repo README](https://github.com/onebrain-ai/onebrain-cli#readme)**.
12
13
 
13
- On install, the `postinstall.js` script downloads the platform-native binary from the matching [GitHub Release](https://github.com/onebrain-ai/onebrain-cli/releases) and places it at `./bin/onebrain` (or `onebrain.exe` on Windows). The `onebrain` command is a thin Node shim that execs the native binary.
14
+ ## Supported platforms
14
15
 
15
- | Host | Binary downloaded |
16
- |---|---|
17
- | macOS Apple Silicon | `onebrain-aarch64-apple-darwin.tar.gz` |
18
- | macOS Intel | `onebrain-x86_64-apple-darwin.tar.gz` |
19
- | Linux ARM64 (glibc) | `onebrain-aarch64-unknown-linux-gnu.tar.gz` |
20
- | Linux x86_64 (glibc) | `onebrain-x86_64-unknown-linux-gnu.tar.gz` |
21
- | Windows ARM64 | `onebrain-aarch64-pc-windows-msvc.zip` |
22
- | Windows x86_64 | `onebrain-x86_64-pc-windows-msvc.zip` |
16
+ The postinstall auto-detects your host and pulls the matching binary. On Linux it detects libc (glibc vs musl) and 32-bit ARM version (ARMv6 vs ARMv7) at install time — every Raspberry Pi from Pi 1 to Pi 5 is covered.
23
17
 
24
- Linux musl users — install directly from GitHub Releases (musl binary is published there but the npm wrapper currently maps glibc).
18
+ | Host | Binary |
19
+ |---|---|
20
+ | macOS · Apple Silicon (M1–M5) | `onebrain-aarch64-apple-darwin.tar.gz` |
21
+ | macOS · Intel | `onebrain-x86_64-apple-darwin.tar.gz` |
22
+ | Linux · ARM64 glibc (Pi 3/4/5 64-bit OS · Pi Zero 2 W) | `onebrain-aarch64-unknown-linux-gnu.tar.gz` |
23
+ | Linux · ARMv7 32-bit (Pi 2 v1.1+ · Pi 3/4/5 32-bit OS) | `onebrain-armv7-unknown-linux-gnueabihf.tar.gz` |
24
+ | Linux · ARMv6 32-bit (Pi 1 · Pi Zero · Pi Zero W) | `onebrain-arm-unknown-linux-gnueabihf.tar.gz` |
25
+ | Linux · x86_64 glibc | `onebrain-x86_64-unknown-linux-gnu.tar.gz` |
26
+ | Linux · x86_64 musl / Alpine | `onebrain-x86_64-unknown-linux-musl.tar.gz` |
27
+ | Windows · ARM64 | `onebrain-aarch64-pc-windows-msvc.zip` |
28
+ | Windows · x86_64 | `onebrain-x86_64-pc-windows-msvc.zip` |
25
29
 
26
- ## Alternative install paths
30
+ If auto-detection misfires, override it: `ONEBRAIN_CLI_LIBC=glibc|musl` or `ONEBRAIN_CLI_ARM=v6|v7` before `npm install`. (Note: only `x86_64` musl is published — `arm64` musl hosts should use a glibc base or build from source.)
27
31
 
28
- ```bash
29
- # Homebrew (macOS / Linux)
30
- brew tap onebrain-ai/onebrain
31
- brew install onebrain
32
+ ## Other install paths
32
33
 
33
- # Direct GitHub Release download
34
- curl -L https://github.com/onebrain-ai/onebrain-cli/releases/latest
35
-
36
- # In-place self-update once installed
37
- onebrain update
38
- ```
34
+ - **Homebrew** (macOS, canonical) — `brew install onebrain-ai/onebrain/onebrain`
35
+ - **Direct download** — grab the binary for your platform from the [latest release](https://github.com/onebrain-ai/onebrain-cli/releases/latest)
36
+ - **Self-update** once installed — `onebrain update` (Homebrew installs delegate to `brew upgrade`)
39
37
 
40
- The npm wrapper, Homebrew formula, and direct GH Release download all converge on the same binary — pick the one that fits your environment.
38
+ All paths resolve to the same per-platform binary — see the [repo README](https://github.com/onebrain-ai/onebrain-cli#install) for the full comparison.
41
39
 
42
- ## Skipping postinstall
40
+ ## Skipping postinstall (CI)
43
41
 
44
- For CI environments that supply the binary out-of-band, set `ONEBRAIN_CLI_SKIP_POSTINSTALL=1` before `npm install`:
42
+ For environments that supply the binary out-of-band:
45
43
 
46
44
  ```bash
47
45
  ONEBRAIN_CLI_SKIP_POSTINSTALL=1 npm install -g @onebrain-ai/cli
48
46
  ```
49
47
 
50
- The shim still runs but exits with `command not found` (127) until the binary is staged at `node_modules/@onebrain-ai/cli/bin/onebrain`.
51
-
52
- ## Migration from v2.x
53
-
54
- This is the first v3 release on npm. v2.x was the TypeScript/Bun implementation and is now deprecated — use this v3 package going forward. See the [v3.0.0 CHANGELOG](https://github.com/onebrain-ai/onebrain-cli/blob/main/CHANGELOG.md) for the full migration story.
55
-
56
- ## Releasing
57
-
58
- Source for this package lives at `npm-wrapper/` in the [`onebrain-ai/onebrain-cli`](https://github.com/onebrain-ai/onebrain-cli) repository. Publishes happen automatically from the `npm-publish` job in `.github/workflows/release.yml` whenever a stable `vMAJOR.MINOR.PATCH` tag is pushed:
59
-
60
- 1. The job uses npm Trusted Publishers (OIDC `id-token: write`) — there is no long-lived `NPM_TOKEN` secret to rotate.
61
- 2. `npm version "$VERSION" --no-git-tag-version --allow-same-version` rewrites `package.json` to match the git tag, so the wrapper version always equals the binary release version.
62
- 3. `npm publish --access public --provenance` ships the package with a Sigstore attestation linking it to the exact workflow run and commit.
48
+ The shim runs but exits `127` until the binary is staged at `node_modules/@onebrain-ai/cli/bin/onebrain`.
63
49
 
64
- Tags containing `-` (e.g. `v3.0.1-rc.1`) are treated as prereleases and skip the npm publish step. Do not publish this package manually from a local clone — the trusted-publisher policy only honors publishes that originate from this workflow.
50
+ ## Releasing & license
65
51
 
66
- ## License
52
+ Source lives at [`npm-wrapper/`](https://github.com/onebrain-ai/onebrain-cli/tree/main/npm-wrapper). CI publishes on each stable `vMAJOR.MINOR.PATCH` tag via npm Trusted Publishers (OIDC, no long-lived token) with `--provenance` for a Sigstore attestation — never published manually, and prerelease tags (containing `-`) are skipped. The wrapper version always equals the binary release version.
67
53
 
68
- [AGPL-3.0-only](LICENSE) — matches the upstream CLI binary. If you make a modified version available to users over a network (AGPL §13 — SaaS, internal APIs, any networked interaction), you must release your modifications under the same license. For commercial licensing inquiries, contact [hello@onebrain.run](mailto:hello@onebrain.run).
54
+ [AGPL-3.0-only](https://github.com/onebrain-ai/onebrain-cli/blob/main/LICENSE), matching the upstream CLI binary. For commercial licensing, contact [hello@onebrain.run](mailto:hello@onebrain.run).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@onebrain-ai/cli",
3
- "version": "3.1.3",
3
+ "version": "3.1.5",
4
4
  "description": "Local-first Rust CLI for OneBrain — personal AI OS for Obsidian. Downloads the matching platform binary from GitHub Releases on install.",
5
5
  "keywords": [
6
6
  "onebrain",