Skip to main content
zCLI is the official command-line tool for Zerops that allows you to manage services, simplify interactions, and configure infrastructure directly from your terminal.

​
What is zCLI?

zCLI provides a comprehensive command-line interface for Zerops, enabling you to:
  • Deploy and manage applications
  • Create and configure projects and services
  • Access Zerops VPN for secure service connections
  • View logs and monitor your services
  • Manage environment variables
  • Import and export project configurations

​
Key Features

Fast Deployments

Deploy your applications with a single command using zcli push

VPN Access

Connect securely to your services via Zerops VPN

Project Management

Create, configure, and manage projects from the terminal

Real-time Logs

Stream and monitor application logs in real-time

​
Supported Platforms

zCLI is available for all major operating systems:
  • Linux (x86 & x64)
  • macOS (x86-64 & ARM64)
  • Windows (x64)

​
Quick Start

Get started with zCLI in three simple steps:
1

Install zCLI

Install zCLI using your preferred method:
curl -L https://zerops.io/zcli/install.sh | sh
See the Installation guide for more options.
2

Authenticate

Log in using your Personal Access Token:
zcli login <your-token>
Get your token from Access Token management.
3

Deploy Your App

Deploy your application with a single command:
zcli push

​
Common Use Cases

​
Deploy Applications

Deploy your application code to Zerops: 
zcli push
This command builds and deploys your application based on the configuration in your zerops.yml file.

​
Access Services via VPN

Connect to your services securely using the Zerops VPN: 
zcli vpn up
Once connected, you can access your databases, caches, and other services directly from your local machine.

​
View Logs

Stream real-time logs from your services: 
zcli service log --follow

​
Manage Projects

Create and manage projects from the command line: 
# Create a new project
zcli project create --name "My Project"

# List all projects
zcli project list

# Import services from YAML
zcli project service-import ./services.yml

​
Configuration

zCLI supports multiple configuration methods:
  1. Configuration files - .zcli.yaml in your project or home directory
  2. Environment variables - Prefix any flag with ZEROPS_
  3. Command-line flags - Pass options directly to commands
See the Configuration guide for detailed information.

​
Getting Help

Every command supports the --help flag: 
zcli --help
zcli push --help
zcli vpn up --help
You can also use the built-in support command: 
zcli support

​
Next Steps

Installation

Detailed installation instructions for all platforms

Commands Reference

Complete reference of all available commands

Configuration

Learn how to configure zCLI for your workflow

API Reference

Explore the REST API as an alternative to CLI

​
Community & Support

  • GitHub: zeropsio/zcli
  • Issues: Report bugs or request features on GitHub
  • Documentation: You’re reading it!
  • Zerops Support: Available through the dashboard

Build docs developers (and LLMs) love

Get started for freeTalk to us