Using zCLI

What is zCLI?

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

Platforms

zCLI currently supports:

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

Get started

To get started, you may install zCLI globally using NPM or Yarn package manager:

npm i -g @zerops/zcli

yarn global add @zerops/zcli

🚀Do you want to manually download the zCli binary?

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

Windows

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

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

Linux/MacOS

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

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

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".

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>

References

zCLI Commands and Usage