Skip to content
axxbetadocs
nextv0.2.26
GitHub
These are the docs of main, not released yet. See the docs of v0.2.26, the latest release.

axx pack

View .mdOpen in Claude

Packs are sets of steps. A project lists the packs it uses in axx-packs.yaml: Axx’s packs by name (rest, sql, kafka, logs, aws-s3, gcp-pubsub, …; see axx pack list), and packs of its own, Go packages that build on the public core and the packs’ contexts, by path (./steps) or Go module path (github.com/team/axx-grpc@v1.2.0). Axx prepares itself with the listed packs on first use and caches the result.

Usage:
axx pack [command]
Available Commands:
add Add packs: axx's by name, others by path or Go module
list List the project's packs and axx's packs it does not use
new Create a pack in <dir> and add it to the project
remove Remove packs from this project
update Move module packs to their newest (or requested) versions and rebuild
Flags:
-h, --help help for pack
Global Flags:
--compact print only what matters (auto-enabled for coding agents)
-c, --config string path to axx.yaml (default: search upward from the working directory)
--json emit machine-readable JSON (stable envelope)
--no-color disable colored output
-v, --verbose count increase log verbosity (-v, -vv)
Use "axx pack [command] --help" for more information about a command.

Add packs: Axx’s by name, others by path or Go module

Usage:
axx pack add <pack>... [flags]
Examples:
axx pack add rest sql
axx pack add ./steps
axx pack add github.com/team/axx-grpc@v1.2.0
Flags:
-h, --help help for add
Global Flags:
--compact print only what matters (auto-enabled for coding agents)
-c, --config string path to axx.yaml (default: search upward from the working directory)
--json emit machine-readable JSON (stable envelope)
--no-color disable colored output
-v, --verbose count increase log verbosity (-v, -vv)

List the project’s packs and Axx’s packs it does not use

Usage:
axx pack list [flags]
Aliases:
list, ls
Flags:
-D, --define stringArray set a property for ${sys:name}, e.g. -D local.host=docker
-h, --help help for list
--profile string apply profiles.<name> / axx.<name>.yaml, several comma-separated in order, like watch,ios (env: AXX_PROFILE)
--set stringArray set a key of axx.yaml for this run, over its files and profiles, e.g. --set run.workers=1 or --set packs.<pack>.<key>=value
Global Flags:
--compact print only what matters (auto-enabled for coding agents)
-c, --config string path to axx.yaml (default: search upward from the working directory)
--json emit machine-readable JSON (stable envelope)
--no-color disable colored output
-v, --verbose count increase log verbosity (-v, -vv)

Create a pack of your own: a Go package that builds on the public core (github.com/nimbusxr/axx/core) and can use the contexts of Axx’s packs (github.com/nimbusxr/axx/packs/rest, …/sql, …). It is added to axx-packs.yaml; the next command that needs the project’s steps prepares Axx with it.

Usage:
axx pack new <dir> [flags]
Flags:
-h, --help help for new
Global Flags:
--compact print only what matters (auto-enabled for coding agents)
-c, --config string path to axx.yaml (default: search upward from the working directory)
--json emit machine-readable JSON (stable envelope)
--no-color disable colored output
-v, --verbose count increase log verbosity (-v, -vv)

Remove packs from this project

Usage:
axx pack remove <pack>... [flags]
Aliases:
remove, rm
Flags:
-h, --help help for remove
Global Flags:
--compact print only what matters (auto-enabled for coding agents)
-c, --config string path to axx.yaml (default: search upward from the working directory)
--json emit machine-readable JSON (stable envelope)
--no-color disable colored output
-v, --verbose count increase log verbosity (-v, -vv)

Clear the pinned versions of module packs (all of them, or the ones named) in axx-packs.lock and rebuild, so each resolves to the version in axx-packs.yaml or, without one, the latest.

Usage:
axx pack update [module]... [flags]
Flags:
-h, --help help for update
Global Flags:
--compact print only what matters (auto-enabled for coding agents)
-c, --config string path to axx.yaml (default: search upward from the working directory)
--json emit machine-readable JSON (stable envelope)
--no-color disable colored output
-v, --verbose count increase log verbosity (-v, -vv)