Zuplo CLI

Zuplo CLI: Source Upgrade

Applies to
Gatewayruntime for API, AI, and MCP gateways
Hosting
Managed EdgeManaged DedicatedSelf-Hosted
Updates your project structure to the latest conventions
Code
zuplo source upgrade [options]

Upgrade a source-controlled AI Gateway

An AI Gateway connected to source control doesn't receive new routes and policies from the template automatically. See Keep the gateway up to date for when to run this command and how to deploy the result.

Preview missing AI Gateway v2 endpoints and policies from the template bundled with your CLI:

TerminalCode
zuplo source upgrade --type ai-gateway

Preview shows proposed additions and a diff without changing files. Review the output, commit or stash local changes, then apply:

TerminalCode
zuplo source upgrade --type ai-gateway --apply

Applying requires the latest stable CLI, compatible installed project dependencies, an online release check, and a clean Git working tree. The CLI asks for confirmation; automation must explicitly pass --apply --prompt=false.

Existing endpoints and policies are preserved. If any addition conflicts or cannot be verified, nothing is applied. Use the printed definitions for a manual upgrade, reviewing authentication and policy order before adding routes.

Review and test the resulting changes before committing and deploying. The command does not install dependencies or deploy your gateway.

Recovery

The CLI prints the backup directory containing originals and journal.json. If interrupted, inspect the journal and restore the originals before retrying; an interrupted upgrade can leave partially updated files.

Without --type ai-gateway, the command retains its existing project-scaffolding behavior. You can also select that behavior explicitly with --type api.

Examples

Upgrade your project structure to the latest conventions

Code
zuplo source upgrade

Specify the project directory path

Code
zuplo source upgrade --dir ./my-zuplo-project

Preview versioned AI Gateway additions without changing files

Code
zuplo source upgrade --type ai-gateway

Validate, preview, and confirm AI Gateway additions

Code
zuplo source upgrade --type ai-gateway --apply

Options

--type

Upgrade project scaffolding (api) or preview AI Gateway template additions

Type: stringDefault: "api"Choices: api, ai-gateway

--apply

Apply verified AI Gateway additions after preview and confirmation

Type: booleanDefault: false

Global options

The following global options are available for all commands:

Additional resources

Last modified on