Skip to main content
Skip to main content

Using zCLI

zCLI is the command-line tool for Zerops that allows users to manage services, simplify interactions, and configure infrastructure directly from the terminal.

For detailed information, see the Configuration and Commands Reference pages.

Platforms

zCLI currently supports:

  • Linux (x86 & x64)
  • macOS (x86-64 & ARM64)
  • Windows (x64)

Get started

Manual Installation

To download the zCLI directly, get the latest release from GitHub.

Linux/MacOS

curl -L https://zerops.io/zcli/install.sh | sh

zCLI will be installed inside /usr/bin or /usr/local/bin.

Windows

irm https://zerops.io/zcli/install.ps1 | iex

zCLI will be installed inside C:\Program Files\ or C:\Program Files (x86)\

Using Package Managers

You can also install zCLI using package managers:

npm i -g @zerops/zcli
yarn global add @zerops/zcli

NixOS

Note

Make sure nix-command and flakes are enabled, if not. You can also use --extra-experimental-features 'nix-command flakes' with nix.

Clone the zCLI repository and build the binary.

git clone https://github.com/zeropsio/zcli
cd zcli
nix develop
nix build

You can find zCLI binary inside result/bin.

Personal access tokens

Personal tokens allow you to securely access Zerops directly. You can create one or more personal tokens and manage them in Zerops GUI.

Managing your access tokens

To create a new personal access token, go to Access Tokens management and click "Generate a new access token".

personal access tokens

You may delete an access token anytime.

Using access tokens

You may use an access token to access Zerops using this command:

zcli login <token>