Cloud instances

Not every device has to be hardware you own. The platform can provision a machine in your cloud account, install the device agent on it, and register it as an ordinary device. From that point on it behaves like any other target: it takes jobs, runs benchmarks, and appears in devices list.

Three groups cover this, in the order you use them: a credential for your cloud account, an image catalogue, and the instances themselves. vpn is the network side, for when an instance has to reach a private network.

Cloud credentials

The platform needs permission to create machines in your account. That permission is stored as a cloud credential.

Command	What it does
cloud-credentials list	Stored credentials, with their secrets redacted.
cloud-credentials get <id>	One credential.
cloud-credentials create --body '<json>'	Store one.
cloud-credentials update <id> --body '<json>'	Change one.
cloud-credentials test <id>	Check that it still works, before you find out during a provision.
cloud-credentials delete <id>	Remove one.

Run cloud-credentials test after any rotation on the cloud side. It is the difference between a clear "this credential is stale" and a provision that fails halfway.

Images

clika-rt cloud-images refresh

The platform caches the machine images available in each region. refresh re-reads them from the provider, which you need after a new image is published and before it can be selected.

Instances

clika-rt cloud-instances [command]

Subcommand	Purpose
catalog	The instance types, regions and images you can provision, given your stored credentials. Read this before writing a create body.
list	Instances the platform has provisioned.
get <id>	One instance with its current state.
create --body '<json>'	Provision an instance.
start <id>	Start a stopped instance.
stop <id>	Stop it without destroying it, which usually stops the compute charge while keeping the disk.
terminate <id>	Destroy it.
delete <id>	Remove the platform's record of it.
retry <id>	Retry a provision that failed partway.
refresh-post	Re-read every instance's state from the provider.
refresh-post-id <id>	Re-read one instance's state.

A typical first run:

clika-rt cloud-credentials test 5b2e0a1c-3d4e-5f60-7182-93a4b5c6d7e8
clika-rt cloud-instances catalog
clika-rt cloud-instances create --body '<json from the catalog>'
clika-rt cloud-instances list

Provisioning is asynchronous. create returns as soon as the request is accepted, and the instance moves through its states afterwards. Watch it with cloud-instances get <id>, or with the event feed, which reports the device coming online once the agent registers.

stop, terminate and delete are three different things, and the distinction costs money if you get it wrong. stop keeps the instance and its disk. terminate destroys the instance at the provider. delete removes the platform's record, which is what you want only after the instance is already gone.

VPN

clika-rt vpn list
clika-rt vpn setup --body '<json>'
clika-rt vpn verify <id>
clika-rt vpn orchestrator-config
clika-rt vpn delete <id>

vpn orchestrator-config prints the orchestrator's own WireGuard configuration, which is what you install on the other end of the tunnel.

A VPN gateway lets provisioned instances, or devices on a private network, reach the platform and be reached by it without exposing anything publicly. vpn verify checks the tunnel end to end, which is worth running before you conclude a device is broken.

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-rt cloud-credentials

cloud-credentials has 6 subcommands.

clika-rt cloud-credentials create

Create cloud credential

clika-rt cloud-credentials 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/cloud-credentials. MCP tool name: post_cloud_credentials.

clika-rt cloud-credentials delete

Delete cloud credential

clika-rt cloud-credentials delete <id> [flags]

Positional arguments: required <id>.

Flag	Type	Default	Meaning
--raw	bool	false	print raw response without pretty-printing

Endpoint: DELETE /api/cloud-credentials/{id}. MCP tool name: delete_cloud_credentials_id.

clika-rt cloud-credentials get

Get cloud credential

clika-rt cloud-credentials get <id> [flags]

Positional arguments: required <id>.

Flag	Type	Default	Meaning
--raw	bool	false	print raw response without pretty-printing

Endpoint: GET /api/cloud-credentials/{id}. MCP tool name: get_cloud_credentials_id.

clika-rt cloud-credentials list

List cloud credentials

clika-rt cloud-credentials list [flags]

Flag	Type	Default	Meaning
--raw	bool	false	print raw response without pretty-printing

Endpoint: GET /api/cloud-credentials. MCP tool name: get_cloud_credentials.

clika-rt cloud-credentials test

Test cloud credential

clika-rt cloud-credentials test <id> [flags]

Positional arguments: required <id>.

Flag	Type	Default	Meaning
--raw	bool	false	print raw response without pretty-printing

Endpoint: POST /api/cloud-credentials/{id}/test. MCP tool name: post_cloud_credentials_id_test.

clika-rt cloud-credentials update

Update cloud credential

clika-rt cloud-credentials update <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/cloud-credentials/{id}. MCP tool name: put_cloud_credentials_id.

clika-rt cloud-images

cloud-images has 1 subcommands.

clika-rt cloud-images refresh

Refresh cloud image cache

clika-rt cloud-images refresh [flags]

Flag	Type	Default	Meaning
--raw	bool	false	print raw response without pretty-printing

Endpoint: POST /api/cloud-images/refresh. MCP tool name: post_cloud_images_refresh.

clika-rt cloud-instances

cloud-instances has 11 subcommands.

clika-rt cloud-instances catalog

Get cloud instance catalog

clika-rt cloud-instances catalog [flags]

Flag	Type	Default	Meaning
--credential_id	string	none	Cloud credential ID to use for API calls
--provider	string	none	Cloud provider: aws or gcp
--raw	bool	false	print raw response without pretty-printing
--region	string	none	Region to list instance types and images for
--zone	string	none	Zone to list instance and accelerator types for

Endpoint: GET /api/cloud-instances/catalog. MCP tool name: get_cloud_instances_catalog.

clika-rt cloud-instances create

Provision a cloud instance

clika-rt cloud-instances 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/cloud-instances. MCP tool name: post_cloud_instances.

clika-rt cloud-instances delete

Delete cloud instance

clika-rt cloud-instances delete <id> [flags]

Positional arguments: required <id>.

Flag	Type	Default	Meaning
--raw	bool	false	print raw response without pretty-printing

Endpoint: DELETE /api/cloud-instances/{id}. MCP tool name: delete_cloud_instances_id.

clika-rt cloud-instances get

Get cloud instance

clika-rt cloud-instances get <id> [flags]

Positional arguments: required <id>.

Flag	Type	Default	Meaning
--raw	bool	false	print raw response without pretty-printing

Endpoint: GET /api/cloud-instances/{id}. MCP tool name: get_cloud_instances_id.

clika-rt cloud-instances list

List cloud instances

clika-rt cloud-instances list [flags]

Flag	Type	Default	Meaning
--raw	bool	false	print raw response without pretty-printing
--status	string	none	Filter by status (pending, provisioning, installing_agent, registered, running, terminating, terminated, error)

Endpoint: GET /api/cloud-instances. MCP tool name: get_cloud_instances.

clika-rt cloud-instances refresh-post

Refresh all cloud instance statuses

clika-rt cloud-instances refresh-post [flags]

Flag	Type	Default	Meaning
--raw	bool	false	print raw response without pretty-printing

Endpoint: POST /api/cloud-instances/refresh. MCP tool name: post_cloud_instances_refresh.

clika-rt cloud-instances refresh-post-id

Refresh single cloud instance status

clika-rt cloud-instances refresh-post-id <id> [flags]

Positional arguments: required <id>.

Flag	Type	Default	Meaning
--raw	bool	false	print raw response without pretty-printing

Endpoint: POST /api/cloud-instances/{id}/refresh. MCP tool name: post_cloud_instances_id_refresh.

clika-rt cloud-instances retry

Retry failed cloud instance

clika-rt cloud-instances retry <id> [flags]

Positional arguments: required <id>.

Flag	Type	Default	Meaning
--raw	bool	false	print raw response without pretty-printing

Endpoint: POST /api/cloud-instances/{id}/retry. MCP tool name: post_cloud_instances_id_retry.

clika-rt cloud-instances start

Start cloud instance

clika-rt cloud-instances start <id> [flags]

Positional arguments: required <id>.

Flag	Type	Default	Meaning
--raw	bool	false	print raw response without pretty-printing

Endpoint: POST /api/cloud-instances/{id}/start. MCP tool name: post_cloud_instances_id_start.

clika-rt cloud-instances stop

Stop cloud instance

clika-rt cloud-instances stop <id> [flags]

Positional arguments: required <id>.

Flag	Type	Default	Meaning
--raw	bool	false	print raw response without pretty-printing

Endpoint: POST /api/cloud-instances/{id}/stop. MCP tool name: post_cloud_instances_id_stop.

clika-rt cloud-instances terminate

Terminate cloud instance

clika-rt cloud-instances terminate <id> [flags]

Positional arguments: required <id>.

Flag	Type	Default	Meaning
--raw	bool	false	print raw response without pretty-printing

Endpoint: POST /api/cloud-instances/{id}/terminate. MCP tool name: post_cloud_instances_id_terminate.

clika-rt vpn

vpn has 5 subcommands.

clika-rt vpn delete

Delete VPN gateway

clika-rt vpn delete <id> [flags]

Positional arguments: required <id>.

Flag	Type	Default	Meaning
--raw	bool	false	print raw response without pretty-printing

Endpoint: DELETE /api/vpn/{id}. MCP tool name: delete_vpn_id.

clika-rt vpn list

List VPN configs

clika-rt vpn list [flags]

Flag	Type	Default	Meaning
--raw	bool	false	print raw response without pretty-printing

Endpoint: GET /api/vpn. MCP tool name: get_vpn.

clika-rt vpn orchestrator-config

Get orchestrator WireGuard config

clika-rt vpn orchestrator-config <id> [flags]

Positional arguments: required <id>.

Flag	Type	Default	Meaning
--raw	bool	false	print raw response without pretty-printing

Endpoint: GET /api/vpn/{id}/orchestrator-config. MCP tool name: get_vpn_id_orchestrator_config.

clika-rt vpn setup

Setup VPN gateway

clika-rt vpn setup [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/vpn/setup. MCP tool name: post_vpn_setup.

clika-rt vpn verify

Verify VPN connectivity

clika-rt vpn verify <id> [flags]

Positional arguments: required <id>.

Flag	Type	Default	Meaning
--raw	bool	false	print raw response without pretty-printing

Endpoint: POST /api/vpn/{id}/verify. MCP tool name: post_vpn_id_verify.

Related

• Devices: what a provisioned instance becomes once its agent registers.
• Events, metrics and alerts: watching a provision complete.
• Organizations, projects and access: who may store a cloud credential.