hiloop CLI is a thin REST/JSON client over the public control-plane edge (ADR 0032). Install
it and authenticate per the quickstart, then use the commands below.
hiloop
The hiloop control-plane CLI
Usage: hiloop [OPTIONS] <COMMAND>
Commands:
whoami Print the identity the API resolves for your credential (`GET /v1/whoami`)
api Make an authenticated request to an arbitrary API path (gh-style passthrough). Covers the whole REST surface; the response body is printed as JSON
run Wrap an agent command and stream its telemetry to the hiloop gateway. Everything after `--` is the command to run, e.g. `hiloop run -- claude "fix the bug"`. The child's exit code is propagated, so `hiloop run` is transparent in scripts
help Print this message or the help of the given subcommand(s)
Options:
--api-url <API_URL> Base URL of the hiloop API edge (provisional default; the hosted edge is not finalized and the REST transcoder is not deployed yet — ADR-0032) [env: HILOOP_API_URL=] [default: https://api.hiloop.ai]
--api-key <API_KEY> API key (bearer credential), unified across the API CLI and the interceptor (ADR-0033 §6). TODO(HIL-102): replace with `hiloop login` + OS keychain [env: HILOOP_API_KEY]
-h, --help Print help
-V, --version Print version
hiloop api
Make an authenticated request to an arbitrary API path (gh-style passthrough). Covers the whole REST surface; the response body is printed as JSON
Usage: hiloop api [OPTIONS] <PATH>
Arguments:
<PATH>
API path, e.g. `/v1/whoami`
Options:
--api-url <API_URL>
Base URL of the hiloop API edge (provisional default; the hosted edge is not finalized and the REST transcoder is not deployed yet — ADR-0032)
[env: HILOOP_API_URL=]
[default: https://api.hiloop.ai]
-X, --method <METHOD>
HTTP method
Possible values:
- get: `GET`
- post: `POST`
- put: `PUT`
- patch: `PATCH`
- delete: `DELETE`
[default: get]
--api-key <API_KEY>
API key (bearer credential), unified across the API CLI and the interceptor (ADR-0033 §6). TODO(HIL-102): replace with `hiloop login` + OS keychain
[env: HILOOP_API_KEY]
-d, --data <DATA>
JSON request body. Inline (`'{"k":1}'`) or `@file` to read from a file
-H, --header <HEADER>
Extra request header `Name: Value` (repeatable)
--output <OUTPUT>
Output format (only `json` is supported for the generic passthrough)
[default: json]
[possible values: json]
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
hiloop run
Wrap an agent command and stream its telemetry to the hiloop gateway. Everything after `--` is the command to run, e.g. `hiloop run -- claude "fix the bug"`. The child's exit code is propagated, so `hiloop run` is transparent in scripts
Usage: hiloop run [OPTIONS] --endpoint <ENDPOINT> -- <COMMAND>...
Arguments:
<COMMAND>... The command to wrap; everything after `--` is passed to the child
Options:
--api-url <API_URL> Base URL of the hiloop API edge (provisional default; the hosted edge is not finalized and the REST transcoder is not deployed yet — ADR-0032) [env: HILOOP_API_URL=] [default: https://api.hiloop.ai]
--endpoint <ENDPOINT> Telemetry gateway gRPC endpoint, e.g. `https://telemetry.staging.hiloop.ai:443`. Required — pass `--endpoint` or set `HILOOP_TELEMETRY_ENDPOINT`. The gateway credential is the `HILOOP_API_KEY` the exporter reads from the environment (ADR-0033 §6); an authenticated gateway derives the tenant from it [env: HILOOP_TELEMETRY_ENDPOINT=]
--api-key <API_KEY> API key (bearer credential), unified across the API CLI and the interceptor (ADR-0033 §6). TODO(HIL-102): replace with `hiloop login` + OS keychain [env: HILOOP_API_KEY]
--insecure Use cleartext h2c instead of TLS for the gateway connection (local dev gateways only)
--project-id <PROJECT_ID> Project to record captured events under [env: HILOOP_PROJECT_ID=] [default: default]
-h, --help Print help
-V, --version Print version
hiloop whoami
Print the identity the API resolves for your credential (`GET /v1/whoami`)
Usage: hiloop whoami [OPTIONS]
Options:
--api-url <API_URL> Base URL of the hiloop API edge (provisional default; the hosted edge is not finalized and the REST transcoder is not deployed yet — ADR-0032) [env: HILOOP_API_URL=] [default: https://api.hiloop.ai]
--output <OUTPUT> Output format [default: table] [possible values: table, json]
--api-key <API_KEY> API key (bearer credential), unified across the API CLI and the interceptor (ADR-0033 §6). TODO(HIL-102): replace with `hiloop login` + OS keychain [env: HILOOP_API_KEY]
-h, --help Print help
-V, --version Print version