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.| Command | Description |
|---|---|
onboard | Interactive first-run setup wizard |
run | Bootstrap setup (onboard + doctor) and start the server |
configure | Update configuration sections interactively |
doctor | Run diagnostic checks on your setup |
env | Print environment variables for deployment |
allowed-hostname | Allow a hostname for authenticated/private mode access |
Control-plane client
These commands interact with a running Zmeel server via its API.| Command | Description |
|---|---|
context | Manage CLI context profiles (API base, company, credentials) |
company | List, inspect, and delete companies |
issue | Create, update, list, and manage issues |
agent | List agents and generate local CLI credentials |
approval | List, approve, reject, and comment on approvals |
activity | Query the activity log |
dashboard | View a company dashboard summary |
heartbeat | Trigger and stream an agent heartbeat manually |
Global options
All control-plane client commands accept these options.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.Base URL for the Zmeel server API (for example
http://localhost:3100).Bearer token for authenticated API calls.
Path to a CLI context file. Overrides the default context at
~/.zmeel/context.json.CLI context profile name to load from the context file.
--json
Output raw JSON instead of formatted text. Useful for scripting.
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:
| Path | Contents |
|---|---|
~/.zmeel/instances/default/config.json | Instance configuration |
~/.zmeel/instances/default/db | Embedded PostgreSQL data |
~/.zmeel/instances/default/logs | Server logs |
~/.zmeel/instances/default/data/storage | File storage |
~/.zmeel/instances/default/secrets/master.key | Local encryption key |