@verbumia/cli

@verbumia/cli

Command-line interface for Verbumia translation management. Sits next to the API and the React SDK; calls into the public HTTP surface using a Verbumia API key.

Install

npm install -g @verbumia/cli
# or
npx @verbumia/cli --help

Quick start

# 1. Authenticate against the cloud (or your self-hosted instance)
verbumia login --host https://api.verbumia.ca --token vrb_live_<prefix>.<secret>

# 2. Bind the current directory to a project
verbumia init --project 069fc15d-…  --version main

# 3. Run a command
verbumia keys list

Configuration

Two files are involved:

• verbumia.config.json — per-project, committed to the repo. Contains the host + project_uuid + version_slug. Any command resolves it by walking up from the current directory.

• ~/.verbumia/credentials — per-user, never committed. JSON file with mode 0600 keyed by host so the same user can hold credentials for multiple Verbumia deployments simultaneously (e.g. cloud + local dev + self-hosted prod). The currently active host is recorded as default.

The credentials file shape:

{
  "default": "https://api.verbumia.ca",
  "hosts": {
    "https://api.verbumia.ca":     { "api_key": "vrb_live_…", "user_email": "…" },
    "https://api.dev.verbumia.ca": { "api_key": "vrb_live_…" }
  }
}

Commands (V1)

Command	Purpose
login	Store an API key for a host
logout	Remove credentials for a host
whoami	Show the active host + masked key
init	Scaffold verbumia.config.json in the current dir
keys list	List keys for the configured project

The CLI is intentionally minimal in V1; richer commands (keys pull, keys push, releases, import, export) ship in V1.1.

Auth headers

Every API call emits Authorization: ApiKey <prefix>.<secret> (capital A, lowercase k). Required scopes vary by command — project:read for keys list, project:write for any future mutation command. Configure scopes when generating the key in the dashboard at Org Settings → API Keys.

License

MIT