Zuplo CLI

The command-line interface for Zuplo.

zup <command>

Commands:
  zup convert   Converts routes.json to routes.oas.json
  zup delete    Deletes the zup at the URL
  zup deploy    Deploys current Git branch of the current directory
  zup dev       Runs the zup locally
  zup list      Lists all deployed zups
  zup link      Links information from your Zuplo account to your local machine
  zup login     Authenticates the user
  zup test      Runs the tests under /tests against an endpoint
  zup project   Project commands
  zup tunnel    Tunnel commands
  zup variable  Variable commands

zup project

Project commands

Commands:
  zup project update  Updates your project structure to the latest conventions
  zup project import-openapi  Import an OpenAPI file into your Zuplo project

zup tunnel

Tunnel commands

Commands:
  zup tunnel create        Creates a new tunnel in your account
  zup tunnel delete        Deletes a tunnel in your account
  zup tunnel describe      Describes a tunnel in your account
  zup tunnel list          Lists the tunnels in your account
  zup tunnel rotate-token  Rotates the token for a tunnel in your account
  zup tunnel services      Tunnel services commands

zup tunnel services

Tunnel services commands

Commands:
  zup tunnel services describe  Describes the services for this tunnel
  zup tunnel services update    Updates the services for this tunnel

zup variable

Variable commands

Commands:
  zup variable create      Creates a new variable for a branch
  zup variable update      Updates an existing variable for a branch

Changelog

v3

• Version 3 requires Node.js 20. Critical bug fixes will be provided for v2 (using Node.js 18) until September 30, 2024. We encourage you to upgrade to v3 as soon as possible.

v2

• Removes the use of Deno's test runner. We now use the built-in test runner in Node.js. All features are preserved; however, the output of zup test follows the Node.js spec reporter.