Skip to main content

Install the CLI

2 min

Pick one install channel and use the matching upgrade path later. Same sylphx binary everywhere.

Recommended

Servers and agents: use the curl installer. Local macOS: Homebrew when available, otherwise npm or curl. Rust shops: Cargo builds on your host glibc.

curl (standalone)

macOS / Linux
curl -fsSL https://raw.githubusercontent.com/SylphxAI/platform/main/scripts/install-sylphx.sh | bash

# ensure ~/.local/bin is on PATH
export PATH="$HOME/.local/bin:$PATH"
sylphx --version
sylphx doctor

Optional: SYLPHX_CLI_VERSION=0.2.6 pins a product version; SYLPHX_CLI_PREFIX sets the install prefix (default $HOME/.local).

npm / pnpm / bun

npm install -g @sylphx/cli
sylphx --version

The npm package is a distribution adapter. Product version is reported by sylphx --version (Rust crate), not only the npm package number.

Cargo

cargo install sylphx-cli --locked
sylphx --version

Homebrew

brew install sylphxai/tap/sylphx
sylphx --version

Tap

Use the official Sylphx tap formula when published. Upgrade only with brew upgrade — do not overwrite Brew-managed files with a foreign binary.

What we do not ship as CLI channels

  • WASM operator CLI — out of scope. Native binary only.
  • Private GitHub asset URLs as the default customer download — public install uses the npm binary packages / install script.
  • apt / Scoop / winget — deferred; may only repackage the same binary later.

Next

Update the CLI — always upgrade using the same channel you installed with.