APIZDocs

APIZ guide

Install The APIZ CLI

Open /download on your APIZ deployment and choose the archive for your platform. The page always offers the CLI built from the same repository release as the deployed Web image.

The page groups downloads by operating system. The supported artifacts are:

  • Linux x86-64 and ARM64 (tar.gz);
  • macOS Apple Silicon (tar.gz);
  • macOS Intel (tar.gz); and
  • Windows x86-64 (zip).

Each filename includes the exact APIZ version. Do not rename an archive before verifying it, and do not substitute a CLI from a different APIZ deployment.

Install With One Command

On Linux or macOS, copy the command shown on /download. It contains the current deployment origin:

curl -fsSL https://current-host/install.sh | sh

The script detects Linux or macOS and x86-64 or ARM64, downloads the exact CLI version built into that Web deployment, verifies it against the same-origin SHA256SUMS, and installs it to $HOME/.local/bin/apiz. It refuses non-HTTPS remote origins. Set APIZ_INSTALL_DIR to choose another user-owned directory:

curl -fsSL https://current-host/install.sh \
  | APIZ_INSTALL_DIR="$HOME/bin" sh

The installer requires a POSIX sh, tar, standard Unix utilities and one of curl, wget, Python 3.11+ or Node.js 22+. It uses sha256sum or shasum for verification when available, otherwise Python or Node's SHA-256 implementation. Linux containers and macOS use their respective platform archives; installation does not install language packages or require root. Windows remains a manual zip installation. Without HOME, the default is /tmp/.local/bin; choose an explicit writable directory in ephemeral environments.

Optional SDK command generation

Python apiz.cli.install_command(server_url=..., runtime="python") and TypeScript installCommand({serverUrl, runtime: "node"}) from @apiz/sdk/cli return a shell command that downloads and executes this same installer. They do not execute commands, create credentials or accept sandbox objects. runtime chooses the downloader for both the entrypoint and archive downloads: sh (curl/GNU wget), python (python3), or node. The installer itself accepts APIZ_INSTALL_RUNTIME=auto|sh|python|node; the default auto detects available tools. All entrypoints still require a POSIX shell and tar in the target environment. They default to /tmp/apiz/bin; choose install_dir / installDir explicitly when needed. Skip installation for an image with the CLI already present.

Execute the returned command through your provider's native command API and check its result. Invoke /tmp/apiz/bin/apiz explicitly afterward; installation does not change PATH in subsequent processes. An installation error creates no APIZ credential because issuance is a separate step. The command contains no User API Key or Client token.

Verify The Download

Download SHA256SUMS from the same /download page. On Linux or macOS, run:

sha256sum --check --ignore-missing SHA256SUMS

On macOS systems without sha256sum, compare the selected archive with:

shasum -a 256 apiz_<version>_<platform>.tar.gz

On Windows PowerShell, compare the manifest entry with:

Get-FileHash .\apiz_<version>_windows_amd64.zip -Algorithm SHA256

Stop if the computed digest does not exactly match the manifest.

Install Manually On Linux Or macOS

Extract the archive and install it into a user-owned executable directory:

tar -xzf apiz_<version>_<platform>.tar.gz
mkdir -p "$HOME/.local/bin"
install -m 0755 apiz "$HOME/.local/bin/apiz"

Add $HOME/.local/bin to PATH if it is not already present.

Install On Windows

Extract apiz.exe from the zip archive into a user-owned directory and add that directory to the User PATH. Administrator access is not required.

Log In

Point the CLI at the intended Control Plane and start the safe WorkOS login flow:

apiz --server=https://current-host login
apiz --server=https://current-host whoami

The CLI asks only for the short one-time code shown by WorkOS. Never paste an access token, refresh token, or upstream API credential into that prompt.