انتقل إلى المحتوى
رجوع
Command line (CLI)4 دقيقة قراءة

Install the CLI

One command installs the jw3 command line on macOS, Linux or WSL. Node 20 or newer required.

الترجمة غير متاحة بعد — يتم عرض الإنجليزية.

The JW3 command line is distributed as a signed npm package and installed with a single command. It runs on macOS, Linux and WSL, and needs Node.js 20 or newer.

Requirements #

  • Node.js 20+ (node --version)
  • npm (ships with Node.js)
  • curl
  • A POSIX shell (macOS Terminal, Linux, or WSL on Windows)

Install #

bash
curl -fsSL https://www.jw3.ai/install.sh | bash

The installer:

  1. checks your Node.js version and refuses to continue below 20,
  2. downloads the @jw3/cli package,
  3. verifies its SHA-256 checksum before running anything,
  4. installs it globally with npm,
  5. confirms that jw3 --help runs.

Re-running the same command updates an existing install in place.

Verify #

bash
jw3 --help

You should see the version banner and the command list. Then sign in — see Sign in and manage access tokens.

If the install fails #

`node: command not found` or a version error. Install Node.js 20+ from nodejs.org and open a new terminal so PATH refreshes.

Permission error from npm. This is a global-prefix permission problem, not a JW3 problem. Fix it without sudo:

bash
mkdir -p ~/.npm-global
npm config set prefix ~/.npm-global
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.zshrc   # or ~/.bashrc

Open a new terminal and re-run the installer.

`jw3: command not found` right after a successful install. npm's global bin directory is not on your PATH. Run npm config get prefix; the binary lives in <prefix>/bin. Add that directory to PATH.

Checksum mismatch. Nothing is installed when this check fails — that is the point. Re-run the installer; if it persists, download again and compare against the published checksum.

Manual install #

If you would rather not pipe a script into a shell:

bash
curl -fsSLO https://www.jw3.ai/dl/jw3-cli-0.1.0.tgz
curl -fsSLO https://www.jw3.ai/dl/SHA256SUMS.txt
shasum -a 256 jw3-cli-0.1.0.tgz    # compare with the value in SHA256SUMS.txt
npm install -g ./jw3-cli-0.1.0.tgz

Update #

Re-run the install command. The installer is idempotent and installs the current version over the old one.

bash
curl -fsSL https://www.jw3.ai/install.sh | bash

Uninstall #

bash
npm uninstall -g @jw3/cli
rm -rf ~/.config/jw3        # optional: removes stored credentials and local state

Removing ~/.config/jw3 deletes your stored token. It does not touch your JW3 account or any exchange connection — revoke access tokens in the app under Settings → Harness Access.

قائمة التحقق

  • Node.js 20 or newer installed
  • Installer finished and printed the next steps
  • jw3 --help lists the commands

Related documents