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

axiom import

Import proto definitions from a published package

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 import

Import proto definitions from a published package

Download .proto files from a published Axiom package into gen/imports/.

The imported message types become available for use as node inputs/outputs in this package. An entry is added to imports: in axiom.yaml, and axiom generate is run so the IDE and compiler immediately see the new types.

When @version is omitted, the most recently published version is imported — UNLESS this package already pins a different version of the same dependency in axiom.yaml. In that case the bare import is REFUSED (nothing is downloaded or changed) so an existing pin never silently drifts to a newer "latest". To re-pin on purpose, pass the version explicitly (axiom import <package>@<version>); to keep the current pin, re-run with that exact version. A bare re-import of the already-pinned version is allowed and just refreshes its imported message list.

Requires a prior "axiom login".

Examples:

axiom import payments            # first import, or refresh the pinned version
axiom import payments@2.0.1      # pin, or deliberately re-pin, an exact version

Usage

axiom import <package>[@version] [flags]

Flags

FlagShorthandTypeDefaultDescription
--help-hboolhelp for import

See also