Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

There are no published releases yet. You build Xianyun from the repository.

Requirements

Xianyun orchestrates other programs rather than reimplementing them, so they need to be on your PATH.

ToolNeeded for
docker and k3dThe k3d driver, which is what driver: auto selects on Linux
colimaThe colima driver, which driver: auto selects on macOS
kubectlWaiting for the cluster and applying manifests
helm, kustomizeDeployers (see Known limitations)
gitCloning and updating repositories
mirrord or skaffoldEdit mode reloaders
zotA managed registry cache (registry_mirror.managed: true)
certutilTrusting the dev CA in Firefox and other NSS databases

Run xianyun doctor once it’s built to see what’s missing. The repository’s Nix development shell provides most of them.

Supported platforms are x86_64 Linux, aarch64 Linux, and aarch64 macOS. The test suite was last measured on Linux. The macOS numbers in the project notes are older and weren’t re-measured.

Build with Nix

$ nix build .#xianyun        # the CLI
$ nix build .#xianyun-mcp    # the MCP server (includes the CLI)
$ ./result/bin/xianyun-mcp --help

Each package builds one binary. Install xianyun-mcp if you mostly want the agent workflow.

Build with Cargo

You need a Rust toolchain that supports edition 2024 (1.85 or newer).

$ nix develop -c cargo build --release -p xianyun-cli -p xianyun-mcp
$ ls target/release/xianyun target/release/xianyun-mcp

Without Nix, drop the nix develop -c prefix and install the tools from the table yourself.

Copy the binaries somewhere on your PATH, or point your agent at the full path.

Check the install

$ xianyun version
caproni version 0.1.0
  commit: unknown
  built:  unknown

The command says “caproni” because several user-facing strings haven’t been renamed yet. The same goes for parts of --help. This is tracked as GAP-008 in the specification.