README.md

Zerops zCLI

A Command Line Utility / Command Line Interface used for interacting with Zerops platform.

Made with ❤️ for CI/CD development and CLI lovers.

Read the docs →

Supported platforms

• Windows
• Linux
• MacOS (arm64, amd64)
• NixOS

Optional requirements

• Wireguard - utilized by zcli vpn command.
• ping - utilized by zcli vpn command.

Install zCLI

Package managers

Npm

npm i -g @zerops/zcli

Windows

Execute following command in PowerShell:

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

Linux/MacOS

Execute following command in Terminal:

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

NixOS

• Clone this repository
• cd zcli into the root of the cloned repository and run nix develop.
• Run nix build to build the binary / executable of zCLI.
• zCLI's binary / executable will be present in ./result/bin/zcli.

Currently, the zCLI is distributed for Linux (x86 & x64 architecture), macOS (x64 & M1 architecture) and Windows (x64 architecture).

Quick Start

• Create a new personal access token at settings/token-management in Zerops GUI.

• Login to zCLI using the personal access token using the following command:

zcli login <token>

• Run zcli to list commands and the current status

zcli

Additional Documentation

For more information go through https://docs.zerops.io/references/cli.

Development setup

Prerequisites: Go 1.26+, git, make, and curl (used to fetch pinned tooling).

git clone https://github.com/zeropsio/zcli && cd zcli
make tools       # download pinned golangci-lint + goreleaser into ./bin
make build-dev   # build ./bin/zcli for the host platform

Common targets (run make help for the full list):

Target	What it does
make build-dev	Build ./bin/zcli with no optimizations (dlv-friendly).
make install	Build a production zcli and install to ~/.local/bin (same path as install.sh).
make install-dev	Install a zcli-dev binary into $GOBIN (or $GOPATH/bin).
make test	Run the full Go test suite.
make lint	Run golangci-lint across darwin/arm64, linux/amd64, windows/amd64.
make all	Cross-build dev binaries for all release platforms.
make goreleaser-snapshot	Dry-run a full release build into ./dist (no upload).

Tool versions (golangci-lint, goreleaser) are pinned at the top of the Makefile. Bumping a version triggers an automatic reinstall on next use; run make clean-tools to wipe ./bin and force a fresh install.

Want to Contribute?

Contributions to zCLI are welcome and highly appreciated. However, We would like you to go through CONTRIBUTING.md.

Community

To chat with other community members, you can join the Zerops Discord Server.