Skip to main content

How-to guides

Practical guides, each answering one concrete "how do I X". They assume the ground the tutorial covers (a project, a device, a model, a run) and go deeper on one problem at a time, in any order. Entries marked as coming are planned and land here as they are written.

Benchmarks and results​

  • Read benchmark results: the metrics a run returns, the per-sample evidence behind a score, and how to pull both through the API and the CLI.
  • Compare two runs (coming): pick a baseline, read a regression, and share the comparison.

Definitions​

Automation​

  • Using with AI (MCP): give Claude Desktop, Claude Code, Codex or another assistant the platform as a set of tools.
  • Run benchmarks from CI (coming): an API key, clika-cli apply, and clika-cli benchmarks watch as a gate.

Administration​

  • Manage members and API keys: who is in the organization, who is in the project, and how an integration gets its own scoped credential.
  • Register a device by code: enroll a device with a short activation code typed into the agent, when pasting the token command is not practical.
  • Activate a deployment license: activate a platform license, renew it, and issue the runtime credentials a ClikaRT project needs.
  • Update an on-premise platform: learn that a release is published, apply it with the installer, and return to the previous version from the backup the upgrade takes.

ClikaRT on your own machine​

  • Download the ClikaRT SDK: get the runtime, the clikart-cli model CLI and the C++ SDK for your workstation or target device from the deployment, through the web dialog, clika-cli runtime-sdk or MCP, and verify the archive.

For the vocabulary these guides use, see Concepts. For the commands, see Using the CLI.