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

axiom init

Initialize a new Axiom 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 init

Initialize a new Axiom package

Initialize a new Axiom package.

Creates a subdirectory named after the package (the part after the last "/"), then writes axiom.yaml, the standard directory layout, and a .gitignore.

axiom init axiom-official/axiom-conv-ai --language python
# Creates ./axiom-conv-ai/ with axiom.yaml, messages/, nodes/, gen/

For Go packages, also generates a go.mod file.

Usage

axiom init <name> [flags]

Flags

FlagShorthandTypeDefaultDescription
--descriptionstringPackage description (written to axiom.yaml)
--help-hboolhelp for init
--installboolAfter scaffolding, run the project-local dependency install for the language (never system package managers)
--language-lstringgopackage language (go | python | rust | java | typescript | csharp)
--no-agent-guideboolSkip writing the CLAUDE.md agent-authoring guide into the package
--no-example-commentboolOmit the commented example node block from axiom.yaml (useful for scripted/agent use)
--versionstring0.1.0Initial package version

See also