---
title: "axiom init"
description: "Initialize a new Axiom package"
category: reference
surfaces: [cli]
related: [reference/cli/axiom, guides/create-a-node-python, guides/create-a-node-go, guides/create-a-node-typescript, guides/create-a-node-rust, guides/create-a-node-java, guides/create-a-node-csharp]
last_reviewed: 2026-06-06
---

<!-- 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.

```text
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

```sh
axiom init <name> [flags]
```

## Flags

| Flag | Shorthand | Type | Default | Description |
|---|---|---|---|---|
| `--description` |  | string |  | Package description (written to axiom.yaml) |
| `--help` | `-h` | bool |  | help for init |
| `--install` |  | bool |  | After scaffolding, run the project-local dependency install for the language (never system package managers) |
| `--language` | `-l` | string | `go` | package language (go \| python \| rust \| java \| typescript \| csharp) |
| `--no-agent-guide` |  | bool |  | Skip writing the CLAUDE.md agent-authoring guide into the package |
| `--no-example-comment` |  | bool |  | Omit the commented example node block from axiom.yaml (useful for scripted/agent use) |
| `--version` |  | string | `0.1.0` | Initial package version |

## See also

- [axiom](./axiom.md) — Axiom CLI — build and push node packages
- Guide: [Create a node (Python)](../../guides/create-a-node-python.md)
- Guide: [Create a node (Go)](../../guides/create-a-node-go.md)
- Guide: [Create a node (TypeScript)](../../guides/create-a-node-typescript.md)
- Guide: [Create a node (Rust)](../../guides/create-a-node-rust.md)
- Guide: [Create a node (Java)](../../guides/create-a-node-java.md)
- Guide: [Create a node (C#)](../../guides/create-a-node-csharp.md)