Other resource groups
The pages before this one cover the groups you reach for daily. This one covers what is left, and ends with an index of every top-level command so nothing in the tree is undocumented.
Agent and engine packages
The device agent and the inference engine are two separately versioned things the platform distributes to devices.
| Command | What it does |
|---|---|
agent-versions list | Agent versions this deployment publishes. |
agent-versions latest | The newest stable one, which is what a device updates to by default. |
agent-versions create --body '<json>' | Register a new agent version. |
agent-versions delete <version> | Remove one. |
engine-packages list | Inference engine package versions. |
engine-packages latest | The newest enabled one. |
engine-packages create --body '<json>' | Register a version. |
engine-packages delete <version> | Remove one. |
The engine package is entitlement-gated and delivered to a device separately from the agent, which is why a job definition can require it through required_resources.engine and that requirement cannot be forced past.
Provisioning the engine onto one device is devices engine-package <name-or-id>; see devices.
agent self
clika-cli agent self
Deregisters the calling device. This is an endpoint a device agent calls for itself, not something you normally run, because from your own terminal there is no calling device. Deregister a device you administer with devices delete instead.
internal mqtt-authn
clika-cli internal mqtt-authn --body '<json>'
Answers the message broker's authentication callback, so a device is admitted on the enrolment session token it already holds. The broker calls this, not you. It is documented here only because every documented operation becomes a subcommand.
Single sign-on, deployment-wide
| Command | What it does |
|---|---|
sso providers | Identity providers configured on the deployment. |
sso providers-id <id> | One provider. |
sso providers-create --body '<json>' | Add one. |
sso providers-update-id <id> --body '<json>' | Change one. |
sso providers-delete-id <id> | Remove one. |
The per-organization equivalents live under orgs sso-providers*, and the public read used by a sign-in page is auth sso-providers. See organizations, projects and access.
Billing catalogue
clika-cli billing catalog
The plans and prices this deployment offers. The subscription commands that act on them are under orgs; see billing and plans.
billing stripe-webhook is the payment provider's inbound webhook, called by the provider rather than by you.
Public share reads
clika-cli public benchmark-shares <token>
clika-cli public benchmark-shares-card.png <token>
Reads a benchmark result through a share token, which is the same path an anonymous visitor takes. Create the link with benchmark-groups share-mark; see sharing results.
Support windows against your organization
clika-cli support-grants list
The read-only view of any support window currently open against your organization: who, why, and until when. Opening and revoking a window is a platform administrator action, performed from the admin dashboard in the web app.
Your own profile
| Command | What it does |
|---|---|
profile update --body '<json>' | Update your own profile. |
profile avatar-create | Upload a profile picture. |
profile avatar-delete | Remove it. |
profile avatar-user_id <user_id> | Read another user's avatar. |
Complete command index
Every top-level command, in the order clika-cli --help prints it, with where it is documented.
Full command reference
Every command below is generated from the deployment's own API description, so
one subcommand is exactly one platform operation. Each entry names the method,
the endpoint and the MCP tool name, so the same operation is
identifiable whichever surface you drive it from. Path parameters are positional
arguments, query parameters are flags, and a request body is --body or
--body-file. The hand-written commands, the ones that stream, propagate an
exit code, or hand your terminal to ssh, carry no operation line.
The prose above covers the commands most people reach for. This section is the complete surface, for when you need the flag you have not used before.
clika-cli agent
agent has 2 subcommands.
clika-cli agent jobs-run-credential
Fetch the calling device's run credential for a job
clika-cli agent jobs-run-credential <id> [flags]
Positional arguments: required <id>.
| Flag | Type | Default | Meaning |
|---|---|---|---|
--raw | bool | false | print raw response without pretty-printing |
Endpoint: GET /api/agent/jobs/{id}/run-credential. MCP tool name: get_agent_jobs_id_run_credential.
clika-cli agent self
Deregister the calling device
clika-cli agent self [flags]
| Flag | Type | Default | Meaning |
|---|---|---|---|
--raw | bool | false | print raw response without pretty-printing |
Endpoint: DELETE /api/agent/self. MCP tool name: delete_agent_self.
clika-cli agent-versions
agent-versions has 4 subcommands.
clika-cli agent-versions create
Register agent version
clika-cli agent-versions create [flags]
| Flag | Type | Default | Meaning |
|---|---|---|---|
--body | string | none | request body (inline JSON) |
--body-file | string | none | request body (path to a JSON file) |
--raw | bool | false | print raw response without pretty-printing |
Endpoint: POST /api/agent-versions. MCP tool name: post_agent_versions.
clika-cli agent-versions delete
Delete agent version
clika-cli agent-versions delete <version> [flags]
Positional arguments: required <version>.
| Flag | Type | Default | Meaning |
|---|---|---|---|
--raw | bool | false | print raw response without pretty-printing |
Endpoint: DELETE /api/agent-versions/{version}. MCP tool name: delete_agent_versions_version.
clika-cli agent-versions latest
Get latest stable agent version
clika-cli agent-versions latest [flags]
| Flag | Type | Default | Meaning |
|---|---|---|---|
--raw | bool | false | print raw response without pretty-printing |
Endpoint: GET /api/agent-versions/latest. MCP tool name: get_agent_versions_latest.
clika-cli agent-versions list
List agent versions
clika-cli agent-versions list [flags]
| Flag | Type | Default | Meaning |
|---|---|---|---|
--raw | bool | false | print raw response without pretty-printing |
Endpoint: GET /api/agent-versions. MCP tool name: get_agent_versions.
clika-cli billing
billing has 2 subcommands.
clika-cli billing catalog
Billing catalog
clika-cli billing catalog [flags]
| Flag | Type | Default | Meaning |
|---|---|---|---|
--raw | bool | false | print raw response without pretty-printing |
Endpoint: GET /api/billing/catalog. MCP tool name: get_billing_catalog.
clika-cli billing stripe-webhook
Stripe webhook intake
clika-cli billing stripe-webhook [flags]
| Flag | Type | Default | Meaning |
|---|---|---|---|
--raw | bool | false | print raw response without pretty-printing |
Endpoint: POST /api/billing/stripe/webhook. MCP tool name: post_billing_stripe_webhook.
clika-cli engine-packages
engine-packages has 4 subcommands.
clika-cli engine-packages create
Register engine package version
clika-cli engine-packages create [flags]
| Flag | Type | Default | Meaning |
|---|---|---|---|
--body | string | none | request body (inline JSON) |
--body-file | string | none | request body (path to a JSON file) |
--raw | bool | false | print raw response without pretty-printing |
Endpoint: POST /api/engine-packages. MCP tool name: post_engine_packages.
clika-cli engine-packages delete
Delete engine package version
clika-cli engine-packages delete <version> [flags]
Positional arguments: required <version>.
| Flag | Type | Default | Meaning |
|---|---|---|---|
--raw | bool | false | print raw response without pretty-printing |
Endpoint: DELETE /api/engine-packages/{version}. MCP tool name: delete_engine_packages_version.
clika-cli engine-packages latest
Get latest enabled engine package
clika-cli engine-packages latest [flags]
| Flag | Type | Default | Meaning |
|---|---|---|---|
--raw | bool | false | print raw response without pretty-printing |
Endpoint: GET /api/engine-packages/latest. MCP tool name: get_engine_packages_latest.
clika-cli engine-packages list
List engine package versions
clika-cli engine-packages list [flags]
| Flag | Type | Default | Meaning |
|---|---|---|---|
--raw | bool | false | print raw response without pretty-printing |
Endpoint: GET /api/engine-packages. MCP tool name: get_engine_packages.
clika-cli internal
internal has 1 subcommands.
clika-cli internal mqtt-authn
Authenticate an MQTT client on behalf of the broker
clika-cli internal mqtt-authn [flags]
| Flag | Type | Default | Meaning |
|---|---|---|---|
--raw | bool | false | print raw response without pretty-printing |
Endpoint: POST /api/internal/mqtt/authn. MCP tool name: post_internal_mqtt_authn.
clika-cli profile
profile has 4 subcommands.
clika-cli profile avatar-create
Upload profile avatar
clika-cli profile avatar-create [flags]
| Flag | Type | Default | Meaning |
|---|---|---|---|
--body | string | none | request body (inline JSON) |
--body-file | string | none | request body (path to a JSON file) |
--raw | bool | false | print raw response without pretty-printing |
Endpoint: POST /api/profile/avatar. MCP tool name: post_profile_avatar.
clika-cli profile avatar-delete
Delete profile avatar
clika-cli profile avatar-delete [flags]
| Flag | Type | Default | Meaning |
|---|---|---|---|
--raw | bool | false | print raw response without pretty-printing |
Endpoint: DELETE /api/profile/avatar. MCP tool name: delete_profile_avatar.
clika-cli profile avatar-user_id
Get profile avatar
clika-cli profile avatar-user_id <user_id> [flags]
Positional arguments: required <user_id>.
| Flag | Type | Default | Meaning |
|---|---|---|---|
--exp | string | none | Unix-seconds expiry (matched by the HMAC) |
--raw | bool | false | print raw response without pretty-printing |
--size | string | none | Variant size; 256 (default) or 64 |
--token | string | none | HMAC signature token |
Endpoint: GET /api/profile/avatar/{user_id}. MCP tool name: get_profile_avatar_user_id.
clika-cli profile update
Update own profile
clika-cli profile update [flags]
| Flag | Type | Default | Meaning |
|---|---|---|---|
--body | string | none | request body (inline JSON) |
--body-file | string | none | request body (path to a JSON file) |
--raw | bool | false | print raw response without pretty-printing |
Endpoint: PUT /api/profile. MCP tool name: put_profile.
clika-cli public
public has 2 subcommands.
clika-cli public benchmark-shares
Get shared benchmark result (public)
clika-cli public benchmark-shares <token> [flags]
Positional arguments: required <token>.
| Flag | Type | Default | Meaning |
|---|---|---|---|
--raw | bool | false | print raw response without pretty-printing |
Endpoint: GET /api/public/benchmark-shares/{token}. MCP tool name: get_public_benchmark_shares_token.
clika-cli public benchmark-shares-card.png
Get shared benchmark card image (public)
clika-cli public benchmark-shares-card.png <token> [flags]
Positional arguments: required <token>.
| Flag | Type | Default | Meaning |
|---|---|---|---|
--raw | bool | false | print raw response without pretty-printing |
Endpoint: GET /api/public/benchmark-shares/{token}/card.png. MCP tool name: get_public_benchmark_shares_token_card.png.
clika-cli sso
sso has 5 subcommands.
clika-cli sso providers
List SSO providers (admin)
clika-cli sso providers [flags]
| Flag | Type | Default | Meaning |
|---|---|---|---|
--raw | bool | false | print raw response without pretty-printing |
Endpoint: GET /api/sso/providers. MCP tool name: get_sso_providers.
clika-cli sso providers-create
Create SSO provider
clika-cli sso providers-create [flags]
| Flag | Type | Default | Meaning |
|---|---|---|---|
--body | string | none | request body (inline JSON) |
--body-file | string | none | request body (path to a JSON file) |
--raw | bool | false | print raw response without pretty-printing |
Endpoint: POST /api/sso/providers. MCP tool name: post_sso_providers.
clika-cli sso providers-delete-id
Delete SSO provider
clika-cli sso providers-delete-id <id> [flags]
Positional arguments: required <id>.
| Flag | Type | Default | Meaning |
|---|---|---|---|
--raw | bool | false | print raw response without pretty-printing |
Endpoint: DELETE /api/sso/providers/{id}. MCP tool name: delete_sso_providers_id.
clika-cli sso providers-id
Get SSO provider
clika-cli sso providers-id <id> [flags]
Positional arguments: required <id>.
| Flag | Type | Default | Meaning |
|---|---|---|---|
--raw | bool | false | print raw response without pretty-printing |
Endpoint: GET /api/sso/providers/{id}. MCP tool name: get_sso_providers_id.
clika-cli sso providers-update-id
Update SSO provider
clika-cli sso providers-update-id <id> [flags]
Positional arguments: required <id>.
| Flag | Type | Default | Meaning |
|---|---|---|---|
--body | string | none | request body (inline JSON) |
--body-file | string | none | request body (path to a JSON file) |
--raw | bool | false | print raw response without pretty-printing |
Endpoint: PUT /api/sso/providers/{id}. MCP tool name: put_sso_providers_id.
clika-cli support-grants
support-grants has 3 subcommands.
clika-cli support-grants approve
Approve a support access request
clika-cli support-grants approve <id> [flags]
Positional arguments: required <id>.
| Flag | Type | Default | Meaning |
|---|---|---|---|
--raw | bool | false | print raw response without pretty-printing |
Endpoint: POST /api/support-grants/{id}/approve. MCP tool name: post_support_grants_id_approve.
clika-cli support-grants deny
Deny a support access request
clika-cli support-grants deny <id> [flags]
Positional arguments: required <id>.
| Flag | Type | Default | Meaning |
|---|---|---|---|
--raw | bool | false | print raw response without pretty-printing |
Endpoint: POST /api/support-grants/{id}/deny. MCP tool name: post_support_grants_id_deny.
clika-cli support-grants list
Support windows against your organization
clika-cli support-grants list [flags]
| Flag | Type | Default | Meaning |
|---|---|---|---|
--active | string | none | Only live windows |
--pending | string | none | Only requests awaiting your organization's decision |
--raw | bool | false | print raw response without pretty-printing |
Endpoint: GET /api/support-grants. MCP tool name: get_support_grants.
Related
- CLI overview: global flags, output formats and exit codes.
- Cheat sheet: the twenty commands worth memorising.