Zerops CLI Commands Reference
Basic Usage​
All commands support the -h, --help flag which displays help information about the command.
For detailed information about configuration options, environment variables, and logging, see the Zerops CLI Configuration page.
Command Groups​
Account & VPN​
login​
Logs you into Zerops using a generated token or your login credentials.
logout​
Disconnects from VPN and logs out from your Zerops account.
vpn up​
Connects to the Zerops VPN.
Flags:
--auto-disconnect- Automatically disconnect from VPN if already connected--mtu int- Set custom MTU value for Wireguard interface (default: 1420)--projectId string- Required when you have access to multiple projects
You can set a default project ID for VPN connections in a .zcli.yml file or via the ZEROPS_PROJECTID environment variable. See the Configuration page for details.
vpn down​
Disconnects from the Zerops VPN.
For more detailed information about Zerops VPN configuration and troubleshooting, visit the VPN Documentation.
Project Management​
project list​
Lists all projects you have access to.
project delete​
Deletes a project and all its services.
Flags:
--confirm- Skip confirmation prompts for destructive operations--projectId string- Required when you have access to multiple projects
project project-import​
Creates a new project with one or more services from a YAML definition.
Flags:
--orgId string- Organization ID where the project should be created (required for multiple organizations)--workingDir string- Sets a custom working directory (default: "./")
project service-import​
Creates one or more services in an existing project from a YAML definition.
Flags:
--projectId string- Required when you have access to multiple projects
scope project​
Sets the default project for commands that require a project ID.
Instead of using the scope project command, you can also set a default project ID in a .zcli.yml file or via the ZEROPS_PROJECTID environment variable. See the Configuration page for details.
scope reset​
Resets the default project and service scope.
Service Operations​
service list​
Lists all services in a project.
Flags:
--projectId string- Required when you have access to multiple projects
service push​
Builds your application in Zerops and deploys it. This is the recommended way to deploy your code.
Flags:
--archiveFilePath string- Creates a tar.gz archive with application code-g, --deployGitFolder- Include the .git folder in the upload--disableLogs- Disable logs during push-v, --verbose- Log additional debug data to the zCLI debug log file--projectId string- Required when you have access to multiple projects--serviceId string- Required when you have access to multiple services--setup string- Choose setup to use from zerops.yml--versionName string- Adds a custom version name--workingDir string- Sets a custom working directory (default: "./")-w, --workspaceState string- Defines version of workspace to push:clean- pushes the HEAD without local changesstaged- pushes only staged filesall- pushes all staged and unstaged files (default)
--zeropsYamlPath string- Sets a custom path to the zerops.yml file
You can also use zcli push as a shorthand for zcli service push.
To avoid specifying --projectId and --serviceId flags repeatedly, you can set default values in a .zcli.yml file or via environment variables. See the Configuration page for details.
service deploy​
Deploys your application to Zerops. Similar to push but focuses on deployment only.
Flags:
Same as service push command.
service start/stop​
Commands to start or stop a Zerops service.
Flags for both commands:
--projectId string- Required when you have access to multiple projects--serviceId string- Required when you have access to multiple services
service delete​
Deletes a Zerops service.
Flags:
--confirm- Skip confirmation prompts for destructive operations--projectId string- Required when you have access to multiple projects--serviceId string- Required when you have access to multiple services
service enable-subdomain​
Enables access to your service through a Zerops subdomain.
Flags:
--projectId string- Required when you have access to multiple projects--serviceId string- Required when you have access to multiple services
service log​
Gets service runtime or build logs to stdout.
Flags:
--follow- Continuously poll for new log messages--format <format>- Log output format (FULL, SHORT, JSON, JSONSTREAM)--formatTemplate <template>- Custom log format--limit <number>- Number of recent log messages to return (1-1000, default: 100)--messageType <type>- Select APPLICATION or WEBSERVER log messages--minimumSeverity <severity>- Filter by severity level--projectId string- Required when you have access to multiple projects--serviceId string- Required when you have access to multiple services--showBuildLogs- Show build logs instead of runtime logs
Utility Commands​
env​
Displays global environment variables and their paths.
version​
Shows the current zCLI version.
show-debug-logs​
Displays debug logs for troubleshooting.
support​
Displays information about how to contact Zerops support.
completion​
Generates shell autocompletion scripts.
Available Shells:
bash- Generate autocompletion script for Bashfish- Generate autocompletion script for Fishpowershell- Generate autocompletion script for PowerShellzsh- Generate autocompletion script for Zsh
Example: