ZuploZuplo
LoginSign Up
  • Documentation
  • API Reference
Introduction
Getting Started
    Develop using the Portal
      1 - Setup Your Gateway2 - Rate Limiting3 - API Key Auth4 - Deploy5 - Dynamic Rate LimitingMCP - Quick start
    Develop Locally
      1 - Setup Your Gateway2 - Rate Limiting3 - API Key Auth
Concepts
Development
Policies
Handlers
API Keys
MCP Server
MCP Gateway
AI Gateway
Developer Portal
Monetization
Deploying & Source Control
Observability
Networking & Infrastructure
Account Management
Programming API
Build with AI
Zuplo CLI
    OverviewCreate Zuplo APIAuthenticationGlobal OptionsNetwork Connectivitybucket listca-certificate createca-certificate deleteca-certificate describeca-certificate listca-certificate updatecustom-domain createcustom-domain deletecustom-domain listcustom-domain updatedeletedeploydevdocseditorinfoinitlinklistlogoutmtls-certificate createmtls-certificate deletemtls-certificate describemtls-certificate disablemtls-certificate listmtls-certificate updateopenapi convertopenapi mergeopenapi overlayproject createproject infoproject listsource migratesource upgradetesttunnel createtunnel deletetunnel describetunnel listtunnel rotate-tokentunnel services describetunnel services updatevariable createvariable updatewhoami
Migration Guides
Platform LimitsSecuritySupportTrust & ComplianceChangelog
powered by Zudoku
Zuplo CLI

Zuplo CLI: Deploy

Deploys current Git branch of the current directory
Code
zuplo deploy [options]

Common use cases

The following examples assume that you are passing in your --api-key either as an argument or through the ZUPLO_API_KEY environment variable.

Deploying your gateway

TerminalCode
# The following will use the current Git branch as the name of the environment git checkout -b my-new-branch zuplo deploy --project my-project
TerminalCode
# If you don't wish to use the current Git branch as the name of the # environment, you can specify one using --environment zuplo deploy --project my-project --environment my-env-name

Polling timeout

By default, the deploy command will poll the status of the deployment every second for 150 seconds. For most deployments this is enough time for the build and deploy process to complete. However, if you have a large project, this may not be enough time. You can increase the timeout by setting the following environment variables.

  • POLL_INTERVAL - The interval in seconds between each poll. Default is 1 second.
  • MAX_POLL_RETRIES - The maximum number of retries before the command times out. Default is 150.
TerminalCode
POLL_INTERVAL=5000 MAX_POLL_RETRIES=300 zuplo deploy

Note, that even if the CLI times out, the deployment will continue. You can check the status of the deployment in your project in the Zuplo Portal.

Examples

Deploy the current Git branch using the branch name as the environment name

Code
zuplo deploy

Override the environment name instead of using the Git branch name

Code
zuplo deploy --environment my-env

Explicitly specify the account, project, and environment

Code
zuplo deploy --account my-account --project my-project --environment my-env

Options

--account

The account name

Type: string

--environment

The value to use for environment name, instead of the current branch name

Type: string

--self-hosted-endpoint

The endpoint of your self-hosted service to deploy to

Type: string

--fetch-environments

Fetch the environments for your project from Zuplo. If this is false, then the environment will automatically be detected from the git branch.

Type: booleanDefault: false

Global options

The following global options are available for all commands:

  • --help
  • --api-key

Additional resources

  • Custom CI/CD
Edit this page
Last modified on May 29, 2026
deletedev
On this page
  • Common use cases
    • Deploying your gateway
  • Polling timeout
  • Global options
  • Additional resources