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

Command reference

This page is generated from the binary. Some help strings still say “Caproni”; see Known limitations.

xianyun

GitLab Kubernetes Development Kit

Usage: xianyun [OPTIONS] <COMMAND>

Commands:
  up                Start the Caproni cluster and deploy all deployers
  down              Stop the Caproni cluster
  destroy           Destroy the Caproni cluster and delete all its data
  status            Show the status of all services
  update            Update all repository source code
  deploy            Deploy or update Helm charts to the cluster
  update-etc-hosts  Update /etc/hosts file with cluster hostnames
  set-kube-context  Add the cluster's context to your kubeconfig
  run               Run reloaders in edit mode until interrupted
  config            Configuration management commands
  version           Print version information
  ca                Manage the Caproni Dev CA certificate
  kubectl           Run kubectl in the context of the cluster
  k9s               Browse the cluster with k9s
  stern             Tail logs from multiple pods with stern
  registry          Manage caproni's host-side registry cache
  logs              View edit mode reloader logs
  doctor            Run built-in diagnostics to help troubleshoot Caproni
  tool              Run an executable on PATH with access to the cluster
  help              Print this message or the help of the given subcommand(s)

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help
  -V, --version                    Print version

xianyun up

Start the Caproni cluster and deploy all deployers

Usage: xianyun up [OPTIONS]

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun down

Stop the Caproni cluster

Usage: xianyun down [OPTIONS]

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun destroy

Destroy the Caproni cluster and delete all its data

Usage: xianyun destroy [OPTIONS]

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun status

Show the status of all services

Usage: xianyun status [OPTIONS]

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun update

Update all repository source code

Usage: xianyun update [OPTIONS]

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
  -n, --verify-only                Check repository states without making any changes [alias: --dry-run]
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --stash                      Automatically stash uncommitted changes before updating
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --repo <REPO>                Update only the specified repository
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --skip <SKIP>                Skip the specified repository
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
  -q, --quiet                      Suppress detailed output, only show summary
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun deploy

Deploy or update Helm charts to the cluster

Usage: xianyun deploy [OPTIONS]

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --repo <REPO>                Deploy only the specified deployer (must match a key under deployers: in caproni.yaml)
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --update                     Update repositories before deploying (pull latest changes for deployer-referenced repos)
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun update-etc-hosts

Update /etc/hosts file with cluster hostnames

Usage: xianyun update-etc-hosts [OPTIONS]

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --dry-run                    Show what would be changed without modifying /etc/hosts
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --remove                     Remove hostnames from /etc/hosts instead of adding them
      --ip <IP>                    IP address to use (default: auto-detect from cluster)
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun set-kube-context

Add the cluster's context to your kubeconfig

Usage: xianyun set-kube-context [OPTIONS]

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
  -u, --use                        Also make the context your current context
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --remove                     Remove the context from the kubeconfig instead of adding it
      --dry-run                    Show what would be changed without modifying the kubeconfig
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --kubeconfig <KUBECONFIG>    Kubeconfig to modify (default: $KUBECONFIG, or ~/.kube/config)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun run

Run reloaders in edit mode until interrupted

Usage: xianyun run [OPTIONS]

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun config

Configuration management commands

Usage: xianyun config [OPTIONS] <COMMAND>

Commands:
  migrate   Migrate configuration to the latest format
  validate  Validate configuration file
  print     Print the resolved configuration
  help      Print this message or the help of the given subcommand(s)

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun config migrate

Migrate configuration to the latest format

Usage: xianyun config migrate [OPTIONS]

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
  -n, --dry-run                    Preview migration without modifying files
  -f, --force                      Skip confirmation prompt
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --skip-backup                Skip creating backup file (use with caution)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun config validate

Validate configuration file

Usage: xianyun config validate [OPTIONS]

Options:
      --allow-deprecated           Allow deprecated (older, non-latest) configuration versions
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun config print

Print the resolved configuration

Usage: xianyun config print [OPTIONS]

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun version

Print version information

Usage: xianyun version [OPTIONS]

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun ca

Manage the Caproni Dev CA certificate

Usage: xianyun ca [OPTIONS] <COMMAND>

Commands:
  trust    Install the CA certificate in the system trust store
  untrust  Remove the CA certificate from the system trust store
  inspect  Show details about the CA certificate
  help     Print this message or the help of the given subcommand(s)

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun ca trust

Install the CA certificate in the system trust store

Usage: xianyun ca trust [OPTIONS]

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun ca untrust

Remove the CA certificate from the system trust store

Usage: xianyun ca untrust [OPTIONS]

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun ca inspect

Show details about the CA certificate

Usage: xianyun ca inspect [OPTIONS]

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun kubectl

Run kubectl in the context of the cluster

Usage: xianyun kubectl [OPTIONS] [ARGS]...

Arguments:
  [ARGS]...  Arguments forwarded verbatim to the `kubectl` executable

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug

xianyun k9s

Browse the cluster with k9s

Usage: xianyun k9s [OPTIONS] [ARGS]...

Arguments:
  [ARGS]...  Arguments forwarded verbatim to the `k9s` executable

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug

xianyun stern

Tail logs from multiple pods with stern

Usage: xianyun stern [OPTIONS] [ARGS]...

Arguments:
  [ARGS]...  Arguments forwarded verbatim to the `stern` executable

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug

xianyun registry

Manage caproni's host-side registry cache

Usage: xianyun registry [OPTIONS] <COMMAND>

Commands:
  status  Show the host-side registry cache state
  start   Start the host-side registry cache (zot process)
  stop    Stop the host-side registry cache (zot process)
  help    Print this message or the help of the given subcommand(s)

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun registry status

Show the host-side registry cache state

Usage: xianyun registry status [OPTIONS]

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
  -o, --output <OUTPUT>            Output format: text or json [default: text] [possible values: text, json]
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun registry start

Start the host-side registry cache (zot process)

Usage: xianyun registry start [OPTIONS]

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun registry stop

Stop the host-side registry cache (zot process)

Usage: xianyun registry stop [OPTIONS]

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun logs

View edit mode reloader logs

Usage: xianyun logs [OPTIONS] [PROC_NAMES]...

Arguments:
  [PROC_NAMES]...  Process names to filter logs to

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
  -n, --tail <TAIL>                Number of lines to show from the end of the logs [default: 25]
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --no-log-prefix              Don't print prefix in logs
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun doctor

Run built-in diagnostics to help troubleshoot Caproni

Usage: xianyun doctor [OPTIONS]

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug
  -h, --help                       Print help

xianyun tool

Run an executable on PATH with access to the cluster

Usage: xianyun tool [OPTIONS] [ARGS]...

Arguments:
  [ARGS]...  The tool to run, followed by its arguments

Options:
  -c, --config-file <CONFIG_FILE>  Path to configuration file. If omitted, caproni will perform a search through the parent directories for caproni.yaml
      --no-cache                   Disables remote config fragment caching. `XIANYUN_NO_CACHE` is the primary env var; `CAPRONI_NO_CACHE` is still recognized as a compatibility alias (see `hooks::before_hook`, which checks it since `clap`'s `env` attribute only supports one name) [env: XIANYUN_NO_CACHE=]
      --log-format <LOG_FORMAT>    Log output format (text or json)
      --log-level <LOG_LEVEL>      Log level (debug, info, warn, error)
      --log-color <LOG_COLOR>      Enable/disable colored log output [possible values: true, false]
      --log-output <LOG_OUTPUT>    Where to write logs (stderr, or a file path)
      --log-source                 Include the source location in log lines
      --debug                      Shorthand for --log-level=debug