Skip to main content

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.

CommandWhat it does
agent-versions listAgent versions this deployment publishes.
agent-versions latestThe 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 listInference engine package versions.
engine-packages latestThe 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​

CommandWhat it does
sso providersIdentity 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​

CommandWhat it does
profile update --body '<json>'Update your own profile.
profile avatar-createUpload a profile picture.
profile avatar-deleteRemove 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.

CommandDocumented in
loginAuthentication and profiles
logoutAuthentication and profiles
self-updateKeeping the CLI current
versionKeeping the CLI current
activation-codesLicensing
agentThis page
agent-versionsThis page
alertsEvents, metrics and alerts
artifactsArtifacts and models
auditEvents, metrics and alerts
authAuthentication and profiles
benchmark-categoriesBenchmarks
benchmark-compatibilityBenchmarks
benchmark-groupsBenchmarks
benchmark-io-schemasBenchmarks
benchmark-metricsBenchmarks
benchmark-task-categoriesBenchmarks
benchmark-typesBenchmarks
benchmarksBenchmarks
billingThis page
cloud-credentialsCloud instances
cloud-imagesCloud instances
cloud-instancesCloud instances
comparisonsBenchmarks
dataset-buildsArtifacts and models
devicesDevices
engine-packagesThis page
enrollment-tokensDevices
entitlement-profilesLicensing
eventsEvents, metrics and alerts
healthEvents, metrics and alerts
hosted-devicesDevices
huggingface-tasksBenchmarks
installKeeping the CLI current
internalThis page
job-definitionsJob definitions
jobsJobs
licenseLicensing
livezEvents, metrics and alerts
metricsEvents, metrics and alerts
model-recommendationsBenchmarks
modelsArtifacts and models
notificationsEvents, metrics and alerts
orgsOrganizations, projects and access
permissionsOrganizations, projects and access
pkiLicensing
profileThis page
projectsOrganizations, projects and access
publicThis page
readyEvents, metrics and alerts
registry-credentialsArtifacts and models
rolesOrganizations, projects and access
runtime-sdkDownload the ClikaRT SDK
service-definitionsServices and service definitions
servicesServices and service definitions
ssoThis page
support-grantsThis page
tag-scriptsDevices
transfersTransfers
usersOrganizations, projects and access
v1Licensing for the runtime endpoints, model deployment for the servings
vpnCloud instances
webhooksEvents, metrics and alerts
applyapply and export
exportapply and export
callMCP server and generic dispatch
mcpMCP server and generic dispatch
toolsMCP server and generic dispatch
completionCLI overview
helpCLI overview

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 3 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>.

FlagTypeDefaultMeaning
--rawboolfalseprint 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]
FlagTypeDefaultMeaning
--rawboolfalseprint raw response without pretty-printing

Endpoint: DELETE /api/agent/self. MCP tool name: delete_agent_self.

clika-cli agent services-run-credential​

Fetch the calling device's run credential for a model serving instance

clika-cli agent services-run-credential <service_id> [flags]

Positional arguments: required <service_id>.

FlagTypeDefaultMeaning
--rawboolfalseprint raw response without pretty-printing

Endpoint: GET /api/agent/services/{service_id}/run-credential. MCP tool name: get_agent_services_service_id_run_credential.

clika-cli agent-versions​

agent-versions has 3 subcommands.

clika-cli agent-versions latest​

Get latest stable agent version

clika-cli agent-versions latest [flags]
FlagTypeDefaultMeaning
--rawboolfalseprint 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]
FlagTypeDefaultMeaning
--fieldsstringnoneComma-separated optional fields to include on each row: checksums, download_urls, signatures
--limitstring50, maximum 200; a larger value is clampedRows to return
--offsetstring0Rows to skip from the newest
--rawboolfalseprint raw response without pretty-printing

Endpoint: GET /api/agent-versions. MCP tool name: get_agent_versions.

clika-cli agent-versions rollbacks​

List devices rolled back from an agent version

clika-cli agent-versions rollbacks <version> [flags]

Positional arguments: required <version>.

FlagTypeDefaultMeaning
--pagestringnonePage number (default: 1)
--page_sizestringnoneItems per page
--rawboolfalseprint raw response without pretty-printing

Endpoint: GET /api/agent-versions/{version}/rollbacks. MCP tool name: get_agent_versions_version_rollbacks.

clika-cli billing​

billing has 2 subcommands.

clika-cli billing catalog​

Billing catalog

clika-cli billing catalog [flags]
FlagTypeDefaultMeaning
--rawboolfalseprint 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]
FlagTypeDefaultMeaning
--rawboolfalseprint raw response without pretty-printing

Endpoint: POST /api/billing/stripe/webhook. MCP tool name: post_billing_stripe_webhook.

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]
FlagTypeDefaultMeaning
--rawboolfalseprint raw response without pretty-printing

Endpoint: POST /api/internal/mqtt/authn. MCP tool name: post_internal_mqtt_authn.

legal has 4 subcommands.

Current legal documents

clika-cli legal documents [flags]
FlagTypeDefaultMeaning
--rawboolfalseprint raw response without pretty-printing

Endpoint: GET /api/legal/documents. MCP tool name: get_legal_documents.

Current legal document

clika-cli legal documents-kind <kind> [flags]

Positional arguments: required <kind>.

FlagTypeDefaultMeaning
--rawboolfalseprint raw response without pretty-printing

Endpoint: GET /api/legal/documents/{kind}. MCP tool name: get_legal_documents_kind.

Legal document versions

clika-cli legal documents-versions <kind> [flags]

Positional arguments: required <kind>.

FlagTypeDefaultMeaning
--rawboolfalseprint raw response without pretty-printing

Endpoint: GET /api/legal/documents/{kind}/versions. MCP tool name: get_legal_documents_kind_versions.

Legal document version

clika-cli legal documents-versions-version <kind> <version> [flags]

Positional arguments: required <kind>, <version>.

FlagTypeDefaultMeaning
--rawboolfalseprint raw response without pretty-printing

Endpoint: GET /api/legal/documents/{kind}/versions/{version}. MCP tool name: get_legal_documents_kind_versions_version.

clika-cli profile​

profile has 6 subcommands.

clika-cli profile avatar-create​

Upload profile avatar

clika-cli profile avatar-create [flags]
FlagTypeDefaultMeaning
--bodystringnonerequest body (inline JSON)
--body-filestringnonerequest body (path to a JSON file)
--rawboolfalseprint 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]
FlagTypeDefaultMeaning
--rawboolfalseprint 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>.

FlagTypeDefaultMeaning
--expstringnoneUnix-seconds expiry (matched by the HMAC)
--rawboolfalseprint raw response without pretty-printing
--sizestringnoneVariant size; 256 (default) or 64
--tokenstringnoneHMAC 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]
FlagTypeDefaultMeaning
--bodystringnonerequest body (inline JSON)
--body-filestringnonerequest body (path to a JSON file)
--rawboolfalseprint raw response without pretty-printing

Endpoint: PUT /api/profile. MCP tool name: put_profile.

clika-cli profile walkthroughs​

List completed walkthroughs

clika-cli profile walkthroughs [flags]
FlagTypeDefaultMeaning
--rawboolfalseprint raw response without pretty-printing

Endpoint: GET /api/profile/walkthroughs. MCP tool name: get_profile_walkthroughs.

clika-cli profile walkthroughs-update-key​

Mark a walkthrough completed

clika-cli profile walkthroughs-update-key <key> [flags]

Positional arguments: required <key>.

FlagTypeDefaultMeaning
--rawboolfalseprint raw response without pretty-printing

Endpoint: PUT /api/profile/walkthroughs/{key}. MCP tool name: put_profile_walkthroughs_key.

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>.

FlagTypeDefaultMeaning
--rawboolfalseprint 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>.

FlagTypeDefaultMeaning
--rawboolfalseprint 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 runtime​

runtime has 3 subcommands.

clika-cli runtime sdk​

List the ClikaRT SDK downloads offered, by selection

clika-cli runtime sdk [flags]
FlagTypeDefaultMeaning
--rawboolfalseprint raw response without pretty-printing

Endpoint: GET /api/runtime/sdk. MCP tool name: get_runtime_sdk.

clika-cli runtime sdk-download-token​

Mint a download link for a ClikaRT SDK selection

clika-cli runtime sdk-download-token <dist> [flags]

Positional arguments: required <dist>.

FlagTypeDefaultMeaning
--rawboolfalseprint raw response without pretty-printing

Endpoint: POST /api/runtime/sdk/{dist}/download-token. MCP tool name: post_runtime_sdk_dist_download_token.

clika-cli runtime sdk-pip-index-token​

Mint the pip index link for the ClikaRT Python wheels

clika-cli runtime sdk-pip-index-token [flags]
FlagTypeDefaultMeaning
--bodystringnonerequest body (inline JSON)
--body-filestringnonerequest body (path to a JSON file)
--rawboolfalseprint raw response without pretty-printing

Endpoint: POST /api/runtime/sdk/pip-index-token. MCP tool name: post_runtime_sdk_pip_index_token.

clika-cli runtime-sdk​

runtime-sdk has 3 subcommands.

clika-cli runtime-sdk download​

Downloads the selection named by <id> (an id from runtime-sdk list, such as linux-amd64-cpp-cu12, or a platform id such as linux-amd64 for the vendor's whole archive) or by the facet flags (--platform with --build, and where they apply --cuda and --python) to <dest>, which defaults to the current directory. When <dest> is an existing directory the file keeps its name inside it; any other <dest> is the file path to write.

clika-cli runtime-sdk download [<id>] [dest] [flags]

Positional arguments: required <id>; optional [<id>], [dest].

FlagTypeDefaultMeaning
--buildstringnonewhat is built: python, cpp, cli, android, rust, go, kotlin (Linux only), or everything for the vendor's whole archive
--cudastringnonethe CUDA image on Linux: 12, 13, both (an archive build) or none
--platformstringnonethe platform the program runs on: linux-amd64, linux-arm64, darwin-arm64, windows-amd64, windows-arm64 or android-arm64
--pythonstringnonethe interpreter for a Python wheel download: cp310, cp311, cp312, cp313 or cp314

clika-cli runtime-sdk list​

Lists one row per selection the deployment can deliver now: the id download takes, the platform, the build, the CUDA image, the interpreter, the backends inside and the size. A selection whose files are not staged on the deployment is left out; --all lists every selection with its state. The facet flags narrow the rows. An older platform that lists only the whole archives shows them as before.

clika-cli runtime-sdk list [flags]
FlagTypeDefaultMeaning
--allboolfalselist every selection, the ones not staged on this deployment included, with its state
--buildstringnonewhat is built: python, cpp, cli, android, rust, go, kotlin (Linux only), or everything for the vendor's whole archive
--cudastringnonethe CUDA image on Linux: 12, 13, both (an archive build) or none
--platformstringnonethe platform the program runs on: linux-amd64, linux-arm64, darwin-arm64, windows-amd64, windows-arm64 or android-arm64
--pythonstringnonethe interpreter for a Python wheel download: cp310, cp311, cp312, cp313 or cp314

clika-cli runtime-sdk pip-command​

Mints a short-lived link to the platform's own package index for the ClikaRT Python packages and prints the one pip command that installs clika_runtime and clika_modelverse at the engine version this deployment runs. pip picks the wheel for the interpreter it runs under; --cuda picks the CUDA image of the runtime wheel on Linux (12 or 13; none is the CPU and Vulkan build). The link stops working ten minutes after it was minted, so run the command soon.

clika-cli runtime-sdk pip-command [flags]
FlagTypeDefaultMeaning
--cudastringnonethe CUDA image of the runtime wheel: 12, 13 or none

clika-cli sso​

sso has 5 subcommands.

clika-cli sso providers​

List SSO providers (admin)

clika-cli sso providers [flags]
FlagTypeDefaultMeaning
--rawboolfalseprint 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]
FlagTypeDefaultMeaning
--bodystringnonerequest body (inline JSON)
--body-filestringnonerequest body (path to a JSON file)
--rawboolfalseprint 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>.

FlagTypeDefaultMeaning
--rawboolfalseprint 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>.

FlagTypeDefaultMeaning
--rawboolfalseprint 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>.

FlagTypeDefaultMeaning
--bodystringnonerequest body (inline JSON)
--body-filestringnonerequest body (path to a JSON file)
--rawboolfalseprint 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>.

FlagTypeDefaultMeaning
--rawboolfalseprint 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>.

FlagTypeDefaultMeaning
--rawboolfalseprint 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]
FlagTypeDefaultMeaning
--activestringnoneOnly live windows
--pendingstringnoneOnly requests awaiting your organization's decision
--rawboolfalseprint raw response without pretty-printing

Endpoint: GET /api/support-grants. MCP tool name: get_support_grants.