Skip to main content
The Zmeel CLI lets you set up, configure, and operate a self-hosted Zmeel instance. It also provides a full control-plane client for managing companies, employees, issues, approvals, and more.

​
Installation

Global install is recommended for day-to-day instance management. Use npx zmeel if you want to run the latest version without committing to a global install.

​
Command categories

​
Setup and diagnostics

These commands manage your local Zmeel instance.

​
Control-plane client

These commands interact with a running Zmeel server via its API.

​
Global options

All control-plane client commands accept these options.
​
string
Path to use as the Zmeel data directory root. Isolates all state (config, database, logs, storage, secrets) away from ~/.zmeel. Useful for running multiple instances side by side.
​
string
Base URL for the Zmeel server API (for example http://localhost:3100).
​
string
Bearer token for authenticated API calls.
​
string
Path to a CLI context file. Overrides the default context at ~/.zmeel/context.json.
​
string
CLI context profile name to load from the context file.
​
Output raw JSON instead of formatted text. Useful for scripting.
​
string
Company ID for company-scoped commands. You can also set this in your context profile to avoid repeating it on every command.

​
Local storage defaults

When no --data-dir is set, Zmeel stores all instance state under ~/.zmeel/instances/default: You can override the base directory or instance ID with environment variables: