Public beta — not for production use. Data may be wiped at any time. Questions? Contact us.
Documentation menu

axiom push

Push the package to the Axiom platform (tenant-private)

View as Markdown
<!-- GENERATED by docs/scripts/gen-cli-reference — DO NOT EDIT. Source of truth: the cobra command definitions in cmd/axiom/cmd/. Regenerate from the repo root with: go run ./docs/scripts/gen-cli-reference -->

axiom push

Push the package to the Axiom platform (tenant-private)

Validate the package locally, then push it to the Axiom platform.

Unlike publishing, a pushed package is only visible to your own tenant — it does not appear in the public marketplace. You can push the same version repeatedly to iterate on it deployed before making it public: each re-push refreshes the code, the package and per-node descriptions, and the OpenAPI spec from your source.

One exception protects anyone who has already composed a deployed node into a graph: once a node is deployed, its input/output WIRE SIGNATURE is frozen for that version. A same-version push that changes a node's input/output message type — or the shape of a local message it uses — is rejected, and you must bump the version in axiom.yaml to publish the new contract. Descriptions, docs, and code are never frozen; only the wire signature is.

When you are satisfied with the package, publish it through the Axiom UI to make it available to others as an immutable versioned release.

Requires a prior "axiom login". The current HEAD must be pushed to the remote.

Usage

axiom push [flags]

Flags

FlagShorthandTypeDefaultDescription
--allow-dirtyboolSkip the uncommitted/unpushed working tree check and push anyway
--help-hboolhelp for push
--jsonboolEmit a single JSON result object instead of human-readable progress output

See also