Installation

zCLI is available for all major operating systems and can be installed using various methods. Choose the installation method that works best for your environment.

System Requirements

zCLI supports the following platforms:

Linux - x86 and x64 architectures
macOS - x86-64 and ARM64 (Apple Silicon)
Windows - x64 architecture

Installation Methods

Linux/macOS
Windows
npm/yarn
Manual
NixOS

Quick Install Script

The easiest way to install zCLI on Linux or macOS is using the installation script:

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

This script will:

Download the latest version of zCLI
Install it to /usr/bin or /usr/local/bin
Make it executable and ready to use

Verify Installation

After installation, verify that zCLI is working:

zcli version

You may need to restart your terminal or run source ~/.bashrc (or your shell’s equivalent) for the zcli command to be available.

PowerShell Installation

Install zCLI on Windows using PowerShell:

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

This script will:

Download the latest version of zCLI
Install it to C:\Program Files\ or C:\Program Files (x86)\
Add it to your PATH

Verify Installation

After installation, verify that zCLI is working:

zcli version

You may need to restart your PowerShell session or terminal for the zcli command to be available.

Using npm

Install zCLI globally using npm:

npm i -g @zerops/zcli

Using yarn

Install zCLI globally using yarn:

yarn global add @zerops/zcli

Verify Installation

After installation, verify that zCLI is working:

zcli version

This method is great for developers who already have Node.js installed and prefer managing CLI tools through npm/yarn.

Download from GitHub

You can manually download zCLI from the GitHub releases page:

Visit the zCLI releases page
Download the latest release for your platform
Extract the archive
Move the binary to a location in your PATH

Linux/macOS

# Extract and move to /usr/local/bin
tar -xzf zcli-*.tar.gz
sudo mv zcli /usr/local/bin/
sudo chmod +x /usr/local/bin/zcli

Windows

Extract the ZIP file
Move zcli.exe to a directory in your PATH (e.g., C:\Program Files\zcli\)
Add the directory to your system PATH if needed

Verify Installation

After installation, verify that zCLI is working:

zcli version

Building from Source

For NixOS users, you can build zCLI from source:

Enable Nix Features

Make sure nix-command and flakes are enabled. You can also use the flag:

--extra-experimental-features 'nix-command flakes'

Clone Repository

Clone the zCLI repository:

git clone https://github.com/zeropsio/zcli
cd zcli

Enter Development Shell

nix develop

Build

nix build

Access Binary

You can find the zCLI binary inside result/bin:

./result/bin/zcli version

Install to System

To install to your system PATH:

nix profile install

Post-Installation

Authentication

After installing zCLI, you need to authenticate with your Zerops account:

Get Your Access Token

Log in to the Zerops GUI
Navigate to Access Token management
Click “Generate a new access token”
Copy the generated token

Use the token to log in:

zcli login <your-token>

Shell Completion (Optional)

Enable shell autocompletion for a better experience:

zcli completion bash > ~/.zerops-completion.bash
echo 'source ~/.zerops-completion.bash' >> ~/.bashrc
source ~/.bashrc

Updating zCLI

Using Installation Scripts

Run the same installation command to update to the latest version:

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

Using Package Managers

npm update -g @zerops/zcli

Troubleshooting

Command not found after installation

If you get a “command not found” error after installation:

Restart your terminal - This ensures your PATH is refreshed

Check your PATH - Make sure the installation directory is in your PATH:

echo $PATH  # Linux/macOS
echo $env:PATH  # Windows PowerShell

Manual PATH addition - Add the installation directory to your PATH if needed

Permission denied on Linux/macOS

If you encounter permission errors:

Use sudo - The installation script may need elevated privileges
Check ownership - Ensure you have write permissions to the installation directory
Use user directory - Consider installing to ~/.local/bin instead

Windows execution policy error

If PowerShell blocks the installation script:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Then run the installation command again.

Network/download issues

If the installation fails due to network issues:

Check your connection - Ensure you can access GitHub and zerops.io
Use manual installation - Download from GitHub releases directly
Use npm/yarn - Try installing via package managers instead

Next Steps

Commands Reference

Explore all available zCLI commands

Configuration

Learn how to configure zCLI for your workflow

API

CLI

System Requirements

Installation Methods

Quick Install Script

Verify Installation

PowerShell Installation

Verify Installation

Using npm

Using yarn

Verify Installation

Download from GitHub

Linux/macOS

Windows

Verify Installation

Building from Source

Install to System

Post-Installation

Authentication

Shell Completion (Optional)

Updating zCLI

Using Installation Scripts

Using Package Managers

Troubleshooting

Next Steps

Commands Reference

Configuration

Build docs developers (and LLMs) love

API

CLI

​System Requirements

​Installation Methods

​Quick Install Script

​Verify Installation

​PowerShell Installation

​Verify Installation

​Using npm

​Using yarn

​Verify Installation

​Download from GitHub

​Linux/macOS

​Windows

​Verify Installation

​Building from Source

​Install to System

​Post-Installation

​Authentication

​Shell Completion (Optional)

​Updating zCLI

​Using Installation Scripts

​Using Package Managers

​Troubleshooting

​Next Steps

Commands Reference

Configuration

Build docs developers (and LLMs) love

System Requirements

Installation Methods

Quick Install Script

Verify Installation

PowerShell Installation

Verify Installation

Using npm

Using yarn

Verify Installation

Download from GitHub

Linux/macOS

Windows

Verify Installation

Building from Source

Install to System

Post-Installation

Authentication

Shell Completion (Optional)

Updating zCLI

Using Installation Scripts

Using Package Managers

Troubleshooting

Next Steps