CLI Reference

The zerokie CLI is the primary interface for managing your apps on the Zerokie platform.

Global options

Flag	Description
--api-url	Override the API endpoint (default: https://api.platform-dev.zerokie.com)
--version	Print the CLI version
--help	Show help for any command

zerokie login

Authenticate with the Zerokie platform.

zerokie login --api-key YOUR_API_KEY

Flag	Required	Description
--api-key	Yes	Your API key from onboarding

Credentials are saved to ~/.zerokie/config.json.

zerokie apps create

Create and deploy a new app. Zerokie supports two app types: container (default) and static.

# Container app (default)
zerokie apps create --name my-app --image nginx:alpine --port 80

# Static site
zerokie apps create --name my-site --type static

Flag	Required	Default	Description
--name	Yes		App name (used in the URL)
--type	No	container	App type: static or container
--image	Yes (container only)		Docker image to deploy
--port	Yes (container only)		Port your app listens on
--env	No		Environment variable (KEY=VALUE, repeatable)
--cpu	No	256	CPU limit in MHz (container only)
--memory	No	512	Memory limit in MB (container only)
--registry-username	No		Registry username for private images
--registry-password	No		Registry password for private images
--registry-url	No		Registry server address (e.g. registry.gitlab.com)

When --type static is used, --image and --port are not required. The app type is immutable after creation.

zerokie apps list

List all your apps.

zerokie apps list

Returns a table with name, image, status, and URL for each app.

zerokie apps status

Show detailed status of a specific app. For static apps, the output includes: app type, platform URL, custom domains, and last deploy timestamp.

zerokie apps status <app-name>

Argument	Required	Description
app-name	Yes	Name of the app

zerokie apps deploy

Redeploy an app. The behavior depends on the app type.

Container deploy

zerokie apps deploy <app-name> --image registry.example.com/my-app:v2

Argument	Required	Description
app-name	Yes	Name of the app to redeploy

Flag	Required	Description
--image	No	New Docker image to deploy. If omitted, the app re-pulls and restarts with the current image tag.
--registry-username	No	Registry username for private images
--registry-password	No	Registry password for private images
--registry-url	No	Registry server address (e.g. registry.gitlab.com)

Static deploy

For static apps, deploy uploads local files to the CDN. The CLI walks the local directory, acquires a deploy lock, uploads changed files, deletes stale remote files, and finalizes with a CDN cache purge.

zerokie apps deploy <app-name> --dir ./dist

Argument	Required	Description
app-name	Yes	Name of the static app to deploy

Flag	Required	Default	Description
--dir	Yes		Source directory containing the files to deploy
--include-hidden	No	false	Include dotfiles (hidden files). .git/ is always excluded.
--force	No	false	Break an existing deploy lock (e.g. from a stuck deploy)

zerokie apps logs

View container logs for an app.

zerokie apps logs <app-name>

Argument	Required	Description
app-name	Yes	Name of the app

Flag	Required	Default	Description
-f, --follow	No	false	Stream logs in real-time
--stderr	No	false	Show stderr instead of stdout

zerokie apps env list

List the current environment variables for an app.

zerokie apps env list <app-name>

Argument	Required	Description
app-name	Yes	Name of the app

Outputs variables sorted alphabetically in KEY=value format.

zerokie apps env set

Add or update environment variables for an app. This triggers a redeployment to apply the changes.

zerokie apps env set <app-name> KEY=VALUE [KEY=VALUE...]

Argument	Required	Description
app-name	Yes	Name of the app
KEY=VALUE	Yes	One or more environment variables to set (repeatable)

zerokie apps env unset

Remove environment variables from an app. This triggers a redeployment to apply the changes.

zerokie apps env unset <app-name> KEY [KEY...]

Argument	Required	Description
app-name	Yes	Name of the app
KEY	Yes	One or more variable names to remove (repeatable)

zerokie apps delete

Delete an app and remove its DNS record.

zerokie apps delete <app-name>

Argument	Required	Description
app-name	Yes	Name of the app to delete

zerokie domains add

Add a custom domain to a static app. After running this command, create a CNAME record with your DNS provider pointing to the provided target.

zerokie domains add <app-name> <domain>

Argument	Required	Description
app-name	Yes	Name of the static app
domain	Yes	Domain to add (e.g. www.example.com). Apex domains are not supported — use a subdomain.

zerokie domains remove

Remove a custom domain from a static app.

zerokie domains remove <app-name> <domain>

Argument	Required	Description
app-name	Yes	Name of the static app
domain	Yes	Domain to remove

zerokie version

Print the CLI version.

zerokie version