CLI Reference¶

The nydus CLI is installed with pip install pynydus. Commands mirror the Python SDK behavior but call the same engine and registry modules directly (they are not implemented as thin wrappers around the Nydus class). LLM and registry settings use environment variables (see Configuration).

spawn¶

Create an Egg from source artifacts. Reads a Nydusfile from the current directory.

nydus spawn [OPTIONS]

Flag	Default	Description
`-o`, `--output`	`./agent.egg`	Output Egg path

hatch¶

Deploy an Egg into a target runtime. Default mode is rebuild (generate from structured modules). Use --passthrough to replay the egg’s archived raw/ snapshot verbatim.

If --secrets is omitted and the egg has secrets, the command interactively prompts for each secret value via stdin. Required secrets that are left empty cause the command to abort.

Output is structured: standard artifacts (AGENTS.md, agent-card.json, apm.yml, mcp.json) are written to the output root, and platform-specific runtime files go into an agent/ subdirectory.

nydus hatch <EGG_PATH> [OPTIONS]

Flag	Default	Description
`EGG_PATH`	(required)	Path to `.egg` file
`-t`, `--target`	(required)	Target: `openclaw`, `zeroclaw`, `letta`
`-o`, `--output`	`./<target>/`	Output directory
`-s`, `--secrets`	(none)	`.env` substitution file
`-P`, `--passthrough`	`false`	Replay egg’s redacted `raw/` snapshot (requires target = source)
`-S`, `--skip-validation`	`false`	Skip egg validation before hatching

env¶

Generate a template .env from an Egg’s secret requirements.

nydus env <EGG_PATH> [OPTIONS]

Flag	Default	Description
`EGG_PATH`	(required)	Path to `.egg` file
`-o`, `--output`	`./hatch.env`	Output `.env` path

inspect¶

Print Egg summary.

nydus inspect <EGG_PATH> [OPTIONS]

Flag	Default	Description
`EGG_PATH`	(required)	Path to `.egg` file
`-s`, `--secrets`	`false`	List all placeholders and occurrences
`-l`, `--logs`	`false`	Show pipeline log summary
`-n`, `--no-validate`	`false`	Skip per-standard schema validation

extract¶

Extract standard artifacts from an Egg. Subcommands: mcp, skills, a2a, apm, agents, specs, all.

nydus extract <SUBCOMMAND> -f <EGG_PATH> [-o <OUTPUT_DIR>]

Subcommand	Default output	Description
`mcp`	`.`	Extract `mcp.json`
`skills`	`.`	Extract `skills/<slug>/SKILL.md` files
`a2a`	`.`	Extract `agent-card.json`
`apm`	`.`	Extract `apm.yml` (passthrough)
`agents`	`.`	Extract per-egg `AGENTS.md`
`specs`	`./specs`	Extract embedded spec snapshots
`all`	`./extracted`	Extract all artifacts at once

diff¶

Compare two Eggs section-by-section (manifest, skills, memory, secrets).

nydus diff <EGG_A> <EGG_B>

Flag	Default	Description
`EGG_A`	(required)	First `.egg` file
`EGG_B`	(required)	Second `.egg` file

delete¶

Delete an Egg file.

nydus delete <EGG_PATH>

Flag	Default	Description
`EGG_PATH`	(required)	Path to `.egg` file

keygen¶

Generate an Ed25519 keypair for Egg signing.

nydus keygen [OPTIONS]

Flag	Default	Description
`-d`, `--dir`	`~/.nydus/keys/`	Directory to write keys to

push¶

Publish an Egg to the Nest registry.

nydus push <EGG_PATH> [OPTIONS]

Flag	Default	Description
`EGG_PATH`	(required)	Path to `.egg` file
`-n`, `--name`	(required)	Registry name (e.g. `user/my-agent`)
`-v`, `--version`	(required)	Version string
`-a`, `--author`	(none)	Author override

pull¶

Download an Egg from the Nest registry.

nydus pull <NAME> [OPTIONS]

Flag	Default	Description
`NAME`	(required)	Registry name
`-v`, `--version`	(required)	Version to pull
`-o`, `--output`	`pulled.egg`	Output path

register¶

nydus register <USERNAME>

Flag	Default	Description
`USERNAME`	(required)	Account username
`--password`, `-p`	(prompted if omitted)	Password (hidden prompt)

login¶

nydus login <USERNAME>

Flag	Default	Description
`USERNAME`	(required)	Account username
`--password`, `-p`	(prompted if omitted)	Password (hidden prompt)

logout¶

Remove stored Nest credentials.

nydus logout