CubeAPM CLI

Ingest & configuration

Push telemetry, manage connection profiles, and maintain the CLI.

Ingest telemetry

Ingest commands read from --file <path> or stdin and use the ingest port, 3130 by default.

cubeapm ingest metrics --format prometheus --file metrics.txt
cubeapm ingest metrics --format otlp --file metrics.pb
cubeapm ingest metrics --format remote-write --file remote-write.pb
cat metrics.txt | cubeapm ingest metrics --format prometheus

cubeapm ingest logs --format jsonline --file logs.jsonl
cubeapm ingest logs --format otlp --file logs.pb
cubeapm ingest logs --format loki --file loki-push.json
cubeapm ingest logs --format elastic --file elastic-bulk.ndjson

The default formats are prometheus for metrics and jsonline for logs; --file - explicitly selects stdin.

Configuration and profiles

cubeapm config view
cubeapm config get server
cubeapm config get current_profile
cubeapm config set server cube.example.com
cubeapm config set auth_method kratos
cubeapm config set output json

cubeapm config profiles list
cubeapm config profiles use production
cubeapm config profiles delete staging

Valid settable keys are server, email, password, auth_method, query_port, ingest_port, admin_port, and output. config get also accepts current_profile; sensitive values are masked by get and view.

Login, version, and update

cubeapm login
cubeapm version
cubeapm update --check
cubeapm update --check -o json
cubeapm update
cubeapm update --yes

login is interactive. version also shows the latest known release from the local update cache, without using the network. update --check does not install; it always asks GitHub and, with -o json, prints current_version, latest_version, update_available, release_url, and install_method. update works on macOS, Linux, and Windows: it asks Update now? [Y/n], verifies the release's SHA-256 checksum, and replaces the binary. --yes skips the question and is required with --no-input or without a terminal. See Installation for the update notice and how to turn it off.

--read-only blocks ingestion, config set, config profiles use and delete, and update (update --check still runs). It does not cover the interactive login, which --no-input blocks.

On this page