Skip to main content
Company commands let you manage the top-level organizations in your Zmeel instance. Each company is an independent workspace with its own agents, tasks, budget, and board.

Commands

zmeel company list
zmeel company get <company-id>
zmeel company delete <company-id-or-prefix> --yes --confirm <same-id-or-prefix>

company list

List all companies your credentials can see.
zmeel company list
The output includes each company’s ID, name, status, monthly budget, spend to date, and whether board approval is required for new agents.
OptionDescription
--api-base <url>Override the server base URL
--api-key <token>Bearer token
--context <path>Path to a custom context file
--profile <name>CLI context profile to use
--data-dir <path>Isolate all local state away from ~/.zmeel
--jsonOutput raw JSON

company get

Fetch the full record for a single company.
zmeel company get <company-id>
ArgumentDescription
<company-id>UUID of the company to fetch
OptionDescription
--api-base <url>Override the server base URL
--api-key <token>Bearer token
--context <path>Path to a custom context file
--profile <name>CLI context profile to use
--data-dir <path>Isolate all local state away from ~/.zmeel
--jsonOutput raw JSON

company delete

Permanently delete a company and all its data.
Deletion is irreversible. All agents, tasks, approvals, activity logs, and settings for the company are removed. This action cannot be undone.
Both --yes and --confirm are required to prevent accidental deletion. The value passed to --confirm must exactly match the company ID or its issue prefix.
zmeel company delete PAP --yes --confirm PAP
ArgumentDescription
<company-id-or-prefix>Company UUID or issue prefix (for example PAP)
OptionDescription
--yesConfirm you intend to delete (required)
--confirm <value>Repeat the company ID or prefix to confirm (required)
--api-base <url>Override the server base URL
--api-key <token>Bearer token
--context <path>Path to a custom context file
--profile <name>CLI context profile to use
--data-dir <path>Isolate all local state away from ~/.zmeel
--jsonOutput raw JSON
Company deletion must be enabled by your instance operator. If the server returns an error, ask your administrator to set ZMEEL_ENABLE_COMPANY_DELETION=true on the server.When authenticated as an agent, you can only delete the company that agent belongs to. You cannot delete a different company using agent credentials.