Operator CLI for Xian networks and nodes
Project description
xian-cli
xian-cli is the operator-facing control plane for Xian networks and nodes. It
handles manifests, node profiles, lifecycle commands, health checks, and local
bootstrap flows without turning xian-abci or xian-stack into user-facing
tools.
The published PyPI package name is xian-tech-cli. The installed console
command remains xian.
Common Workflows
Create a local network from a template:
uv run xian network template list
uv run xian network create local-dev --chain-id xian-local-1 \
--template single-node-dev --generate-validator-key --init-node
uv run xian node start local-dev
uv run xian node status local-dev
Join an existing network with a local profile:
uv run xian network join mainnet-node --network mainnet \
--template embedded-backend --generate-validator-key \
--init-node --restore-snapshot
uv run xian node health mainnet-node
uv run xian node endpoints mainnet-node
Inspect or recover a configured node:
uv run xian doctor mainnet-node
uv run xian doctor mainnet-node --skip-live-checks
uv run xian snapshot restore mainnet-node
Principles
xian-cliowns operator UX. Deterministic node logic stays inxian-abci, and local runtime orchestration stays inxian-stack.- Manifests and node profiles are explicit artifacts, not hidden state.
- Templates and solution packs should accelerate common setups, but they should remain optional. An operator who knows what they are doing should still be able to work directly with manifests, profiles, and node homes.
- Health, endpoint discovery, and diagnostics are first-class operator features, not afterthoughts.
Key Directories
src/xian_cli/: commands, models, manifest handling, and backend integrationtests/: CLI behavior and manifest/profile validation coveragedocs/: lifecycle contracts, architecture notes, and backlog items
What It Covers
- key generation and validator material
- network template and solution-pack discovery
- network creation and network join flows
- node initialization, start, stop, and status
- endpoint and health discovery, including optional dashboard, monitoring, and
stack-managed
xian-intentkit - snapshot restore and doctor diagnostics
- solution-pack starter flows built on
xian-configs
Command Groups
xian keys ...: generate validator and account materialxian network template ...: inspect reusable network templatesxian network create ...: create a local/operator-managed network profilexian network join ...: join an existing canonical or remote networkxian node ...: initialize, start, stop, inspect, and recover a node profilexian doctor ...: run broader local diagnosticsxian solution-pack ...: discover starter flows built on top of the golden path
Validation
uv sync --group dev
uv run ruff check .
uv run ruff format --check .
uv run pytest
Related Docs
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file xian_tech_cli-0.1.0.tar.gz.
File metadata
- Download URL: xian_tech_cli-0.1.0.tar.gz
- Upload date:
- Size: 43.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c8bf8a4d533283c35e15956cc008e737fc84a41515b103e1219c1e89e6a2c217
|
|
| MD5 |
5996c1e008e16eb779e979f7775841ec
|
|
| BLAKE2b-256 |
b0cd346c59f7c37e3d58276a20286b8ac46b16aea4f74c00bb76220a85698f5d
|
Provenance
The following attestation bundles were made for xian_tech_cli-0.1.0.tar.gz:
Publisher:
release.yml on xian-technology/xian-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
xian_tech_cli-0.1.0.tar.gz -
Subject digest:
c8bf8a4d533283c35e15956cc008e737fc84a41515b103e1219c1e89e6a2c217 - Sigstore transparency entry: 1194664209
- Sigstore integration time:
-
Permalink:
xian-technology/xian-cli@3129797b7a53c3bc4490f29e5445e67415ffd6a1 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/xian-technology
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@3129797b7a53c3bc4490f29e5445e67415ffd6a1 -
Trigger Event:
push
-
Statement type:
File details
Details for the file xian_tech_cli-0.1.0-py3-none-any.whl.
File metadata
- Download URL: xian_tech_cli-0.1.0-py3-none-any.whl
- Upload date:
- Size: 31.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1736b215a212a04c53dee540173474fffb86dae34f647bcfdcec3b8554ea389e
|
|
| MD5 |
9ca698caf3aff4432cd2bac4a745f52e
|
|
| BLAKE2b-256 |
747897b2313d3f25ac4a79d39c094629e41a9df4f0172d4071a587943d2634c8
|
Provenance
The following attestation bundles were made for xian_tech_cli-0.1.0-py3-none-any.whl:
Publisher:
release.yml on xian-technology/xian-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
xian_tech_cli-0.1.0-py3-none-any.whl -
Subject digest:
1736b215a212a04c53dee540173474fffb86dae34f647bcfdcec3b8554ea389e - Sigstore transparency entry: 1194664213
- Sigstore integration time:
-
Permalink:
xian-technology/xian-cli@3129797b7a53c3bc4490f29e5445e67415ffd6a1 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/xian-technology
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@3129797b7a53c3bc4490f29e5445e67415ffd6a1 -
Trigger Event:
push
-
Statement type: