axiom client sync
Reconcile a client to match a declarative axiom-client.yaml manifest
View as Markdownaxiom client sync
Reconcile a client to match a declarative axiom-client.yaml manifest
Reconcile a tenant-scoped Client Builder client to match a declarative manifest — kubectl-apply / Terraform semantics, not an imperative script.
axiom-client.yaml lives at the root of your app's own repo: a package.json-style manifest of which PUBLISHED members — a package@version + node, or a saved flow's artifact id, from potentially many publishers — your client SDK should contain, plus their aliases and the languages to build:
client: billing
description: Billing SDK
languages: [python, go]
members:
- package: acme/billing-utils@1.2.0
node: Summarize
alias: summarize
- flow: 01J8Z3K9Q2R4S6T8V0W2X4Y6Z8
alias: run_pipeline
axiom client sync # reads ./axiom-client.yaml
axiom client sync --file path/to/f.yaml
axiom client sync --json # machine-readable outputEach run reconciles the server to match the manifest exactly:
- creates the client (by its "client" name) if it doesn't exist yet
- adds every manifest member missing from the server
- removes every server member no longer listed in the manifest
- builds every manifest language not yet covered by the client's current
build stateA converged run — the manifest unchanged since the last sync — makes NO mutating calls: sync is idempotent, like re-applying an unchanged Kubernetes manifest or Terraform plan.
An omitted package version pins @latest server-side; the resolved pin is printed so an unattended (e.g. CI or agent-driven) run stays reproducible.
Requires a prior "axiom login".
Usage
axiom client sync [flags]Flags
| Flag | Shorthand | Type | Default | Description |
|---|---|---|---|---|
--file | string | axiom-client.yaml | Path to the client manifest | |
--help | -h | bool | help for sync | |
--json | bool | Emit a single JSON result object |
See also
- axiom client — Create and manage Client Builder clients (typed SDKs)