Zuplo CLI

The Zuplo CLI provides convenient tooling for common tasks that you might want to automate. You can use it to deploy Zuplo projects through CI/CD, create and update environment variables, manage your tunnels, and more! It's powered by the Zuplo Developer API, which you can also call directly, if you want to create your own tooling.

Installing

The Zuplo CLI is built using Node.js. It requires Node.js 24.0.0 or greater.

Install Node.js 24.0.0 or later. You can download it from nodejs.org.
Install the Zuplo CLI globally by running the following command:
```
Code
npm install -g zuplo
```
After installing the CLI, you can use the zuplo command to interact with Zuplo.

Verifying Installation

Run the following command to confirm the CLI is installed correctly:

Code
zuplo --version

Updating

To update the Zuplo CLI to the latest version, run the same install command:

Code
npm install -g zuplo@latest

Quick Start

After installing the CLI, log in to your Zuplo account and deploy a project:

Code
zuplo login
zuplo deploy --project my-project

For details on authentication options, including API key usage for CI/CD pipelines, see Authentication.

Commands

Command	Description
`deploy`	Deploy a Zuplo project to an environment
`dev`	Start a local development server
`test`	Run API tests against a deployment
`init`	Initialize a new Zuplo project in the current directory
`link`	Link a local directory to an existing Zuplo project
`list`	List available Zuplo projects
`delete`	Delete a Zuplo project or environment
`login`	Authenticate with your Zuplo account via OAuth
`variable-create`	Create an environment variable
`variable-update`	Update an environment variable
`tunnel-create`	Create a new tunnel
`tunnel-list`	List tunnels for a project
`tunnel-delete`	Delete a tunnel

For a complete list of commands and flags, run zuplo --help or see Global Options.

To scaffold a new project without installing the CLI, see create-zuplo-api. It can also run project create and link for you, so a new working copy comes out already connected to a project on portal.zuplo.com.

Edit this page

Last modified on August 4, 2026

Build with AI Create Zuplo API