Skip to content

setup.md

Latest commit

 

History

History
94 lines (61 loc) · 4.94 KB

setup.md

File metadata and controls

94 lines (61 loc) · 4.94 KB
Raw
title Install & switch versions
permalink /how-to/install
diataxis how-to
redirect_from
/setup
/setup.md

Install & switch versions

This recipe installs the jaiph CLI onto your PATH, verifies it, and switches between releases (stable, nightly, or a specific version).

The curl installer downloads a per-platform standalone binary from the current stable GitHub Release. Node and npm are not required to run that binary; it self-contains the runtime and the agent skill.

Prerequisites

  • A POSIX sh on PATH — the runtime uses sh -c for inline shell lines inside workflows. Any script step also needs the interpreter named by its shebang on PATH (bash by default). The runtime spawns that interpreter explicitly rather than relying on the file's exec bit, so scripts still run under noexec mounts.
  • For the curl installer (step 1): curl and either shasum or sha256sum on PATH.
  • For the PowerShell installer (step 1, Windows): PowerShell (irm/Invoke-WebRequest and Get-FileHash are built in).
  • For the npm alternative (step 1): Node.js and npm on the host.
  • (Optional) minisign on PATH to cryptographically verify the detached release signature. Both installers embed the project public key (jaiph.pub); when minisign is missing they still require the signature file to be present (fail closed when it is missing) but skip verification and fall back to checksum-only with a warning.

1. Install the binary

Use the curl installer:

curl -fsSL https://jaiph.org/install | bash

This downloads jaiph-{darwin|linux}-{arm64|x64}, SHA256SUMS, and the detached signature SHA256SUMS.minisig from the current stable Release, verifies the checksum (and the signature when minisign is available — see Verify the release signature), and installs the binary to ~/.local/bin/jaiph. The installer fails closed if SHA256SUMS.minisig cannot be downloaded. Override the install location with JAIPH_BIN_DIR.

Windows (PowerShell): the curl installer rejects Windows and points you here. Use the PowerShell one-liner instead:

irm https://jaiph.org/install.ps1 | iex

This downloads jaiph-windows-x64.exe, SHA256SUMS, and SHA256SUMS.minisig from the current stable Release, verifies the checksum with Get-FileHash (and the signature when minisign is available — see Verify the release signature), installs the binary to %LOCALAPPDATA%\jaiph\bin\jaiph.exe, and adds that directory to your user PATH (open a new terminal to pick it up). Override the ref with JAIPH_REPO_REF (or the first argument) and the install location with JAIPH_BIN_DIR. Windows ships an x64 binary only — Bun has no Windows arm64 target, so ARM Windows exits with an unsupported-platform message.

(Alternative) Install via npm when you already have Node on the host and want package-manager-tracked installs:

npm install -g jaiph

The npm package exposes dist/src/cli.js as the jaiph command (Node executes it) plus the compiled runtime tree under dist/src/.

2. Add jaiph to PATH (if needed)

If jaiph --version reports command not found, add the install directory to PATH:

export PATH="$HOME/.local/bin:$PATH"   # curl installer

or prepend npm's global bin directory: export PATH="$(npm prefix -g)/bin:$PATH".

3. (Optional) Switch versions

jaiph use nightly      # rolling nightly prerelease
jaiph use 0.11.0       # reinstalls the v0.11.0 release binary

jaiph use re-invokes the step-1 installer (JAIPH_INSTALL_COMMAND, default curl -fsSL https://jaiph.org/install | bash) with JAIPH_REPO_REF set to nightly or v<version>, then replaces ~/.local/bin/jaiph (or JAIPH_BIN_DIR). Override JAIPH_INSTALL_COMMAND for forks, offline bundles, or local scripts.

Verification

jaiph --version

This prints jaiph <version> (sourced from the installed release at build time). After jaiph use <version>, re-run jaiph --version and confirm the printed version matches (for example jaiph 0.11.0 after jaiph use 0.11.0).

Verify the release signature

Every release ships SHA256SUMS and a detached minisign signature SHA256SUMS.minisig. The installer downloads both and verifies when minisign is on PATH.

From a checkout of this repo:

minisign -V -P "$(grep '^RW' jaiph.pub)" -m SHA256SUMS -x SHA256SUMS.minisig

Override with JAIPH_MINISIGN_PUBLIC_KEY only when testing a key rotation before merge.

For maintainer setup, see Contributing — Release signing.

Related