<!-- 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 create node
Scaffold a new node in nodes/
Create a node implementation file and test file in nodes/, then update axiom.yaml.
The node name must be PascalCase. Input and output messages must be defined in messages/messages.proto or available from an imported package in gen/imports/.
If --input or --output are omitted and stdin is a terminal, the command will prompt interactively with a numbered list of all available messages.
The comment block immediately above the function in the generated file is extracted by the publish pipeline and shown in the Axiom registry as this node's description — the same convention used for proto message leading comments. Edit the placeholder before publishing.
Examples:
axiom create node ProcessOrder --input OrderRequest --output OrderConfirmation
axiom create node ValidateOrder --input OrderRequest --output ValidationResult
axiom create node ProcessOrder # interactive: prompts for input and outputUsage
axiom create node <Name> [flags]Flags
| Flag | Shorthand | Type | Default | Description |
|---|---|---|---|---|
--description | string | Node description (optional, can be set later in axiom.yaml) | ||
--help | -h | bool | help for node | |
--input | string | Input message name | ||
--no-generate | bool | Skip running axiom generate after scaffolding (useful when creating multiple nodes before generating) | ||
--output | string | Output message name | ||
--type | string | Node type: unary (default) or pipeline |
See also
- axiom create — Create Axiom resources
- Guide: Create a node (Python)
- Guide: Create a node (Go)
- Guide: Create a node (TypeScript)
- Guide: Create a node (Rust)
- Guide: Create a node (Java)
- Guide: Create a node (C#)
Related