Skip to main content

tare api catalog status

Print when this management plane last ran a catalog sync, which published
catalog version it is on, and how old that catalog is.

The record is written by `catalog sync` -- every run updates it, dry runs
included, so a plane whose scheduled job reports without applying still shows
as being checked. A plane that has never run one says so.

With --max-age or --max-since-run this is a probe, usable from a monitor rather
than only from a terminal. They measure different things and a monitor wants
both: --max-age is the age of the catalog this plane is ON, which grows when the
publisher stops publishing; --max-since-run is how long since this plane last
ran a sync at all, which grows when the job itself stops. Either alone leaves
one of the two faults looking like the other.

Usage:
tare api catalog status [flags]

Examples:
# What is this plane on?
tare api catalog status

# Fail if the applied catalog is older than a week.
tare api catalog status --max-age 168h

# Fail if the sync job has not run in two days, whatever it applied.
tare api catalog status --max-since-run 48h

Flags:
--admin catalog sync --admin read through the admin surface (tars.admin.v1.AdminService) instead of the public one. Required when authenticating with a management plane's ADMIN key; see catalog sync --admin
--max-age duration exit non-zero when the APPLIED CATALOG is older than this (e.g. 168h) -- the age of the published document this plane is on, measured from its exportedAt, not the time since the last sync. A plane converged on a catalog nobody has republished in a month trips this even though its sync job is healthy; use --max-since-run for the job itself. Off by default, which only reports
--max-since-run duration exit non-zero when the LAST SYNC RUN is older than this, report-only runs included. This is the sync job's own liveness, and it is what separates "the publisher stopped publishing" from "this plane stopped syncing" -- two faults --max-age alone reddens identically. Off by default

Global Flags:
--base-url string override the active profile's base URL for this invocation
-o, --output string output format: json (default "json")
-p, --profile string credential profile (overrides AGENTROUTER_PROFILE / active)
-q, --quiet Suppress progress output; only errors and the final summary go to stderr
-v, --verbose Verbose output: plain-mode progress lines plus full per-blob chunk logs to stderr