Skip to main content

​
Schema introspection

Every command below with arguments supports two read-only flags for tooling and AI agents:
  • --show-file-schema: print the JSON Schema for the full request object (the format --filename accepts).
  • --show-argument-schema <flag-name>: print the JSON Schema for one argument’s value. Pass the kebab flag name without the leading -- (e.g. metric-id, not --metric-id).
Both write pure JSON to stdout and never call the API. They cannot be combined with any other command-specific flag.

​
list

List versions for a metric Retrieve all snapshot versions of the metric’s definition, ordered oldest-first. Returns the full version history unpaginated.

​
Usage

honeyhive metric-versions list [options]

​
Options

FlagTypeRequiredDescription
--metric-idstringyesThe unique identifier of the metric whose versions are being listed
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

​
create

Create a new metric version Snapshot the supplied metric definition as a new version. By default the version is created as a draft (deployed: false); set deploy_immediately: true to also make it the live version in the same transaction.

​
Usage

honeyhive metric-versions create [options]

​
Options

FlagTypeRequiredDescription
--contentjsonyesMetric definition snapshot accepted by POST /v1/metrics//versions. Six fields are optional and fall back to server-side defaults when omitted: - description → "" - return_type → "float" - enabled_in_prod → true for HUMAN metrics, false otherwise - needs_ground_truth → false - sampling_percentage → 10 - filters → { "filterArray": [] }
--messagestringyesmessage
--metric-idstringyesThe unique identifier of the metric to version
--deploy-immediately / --no-deploy-immediatelybooleannodeploy_immediately
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

​
deploy

Deploy a specific metric version Mark the named version as the live version for the metric, unmarking any previously deployed version.

​
Usage

honeyhive metric-versions deploy [options]

​
Options

FlagTypeRequiredDescription
--metric-idstringyesThe unique identifier of the metric
--version-namestringyesThe name of the version to deploy
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.