zkm — ZkMultiCloud CLI

Deploy any app to the cloud without learning DevOps.

npx zkm --help

Quick start

1. Set your API key

Get your key from the ZkMultiCloud dashboard under Settings → API Keys, then:

npx zkm config set-key zkm_your_key_here
# or export ZKM_API_KEY=zkm_your_key_here

2. Create a project

npx zkm project create

Follow the interactive prompts to name the project, pick a service type, and paste your GitHub repo URL.

3. Deploy

npx zkm deploy <projectId>

# Stream logs in real time:
npx zkm deploy <projectId> --tail

All commands

zkm auth
  login           Log in with email & password (creates an API key automatically)
  set-key <key>   Store an existing API key locally
  logout          Remove locally stored credentials
  whoami          Show the currently configured API key

zkm config
  show            Show current config (API URL, key prefix, config file path)
  set-key <key>   Store an API key
  set-url <url>   Point the CLI at a self-hosted backend

zkm project (alias: proj)
  list            List all your projects
  get <id>        Show project details and config
  create          Interactively create a new project
  delete <id>     Delete a project

zkm deploy <projectId>
  --tail          Poll and stream deployment logs until done

zkm deployments (alias: deps)
  list <projectId>               List deployments
  logs <projectId> <deployId>    Print logs for a deployment
    --tail                       Poll until the deployment finishes
  get  <projectId> <deployId>    Get a single deployment

zkm apikeys (alias: keys)
  list            List all API keys
  create          Create a new API key
  revoke <id>     Revoke an API key

Environment variables

| Variable | Description | |---|---| | ZKM_API_KEY | API key (overrides the locally stored one) | | ZKM_API_URL | Backend URL (default: https://api.zkmulticloud.com) |

Self-hosted backend

npx zkm config set-url http://localhost:3001
npx zkm config set-key zkm_your_key_here

Install globally (optional)

npm install -g zkm
zkm deploy <projectId> --tail