Tool reference
Tool names are exactly what the server exports. Your client may prefix them with the server name. Flags go in the flags object with underscores, and positional arguments go in args.
Every tool returns stdout, stderr, and exit_code.
Read-only
| Tool | Command | Flags |
|---|---|---|
xianyun_version | xianyun version | none |
xianyun_status | xianyun status | none |
xianyun_doctor | xianyun doctor | none |
xianyun_logs | xianyun logs [PROC_NAMES]... | tail (integer, default 25), no_log_prefix (boolean). Process names go in args. |
xianyun_config_validate | xianyun config validate | allow_deprecated (boolean) |
xianyun_config_print | xianyun config print | none |
xianyun_registry_status | xianyun registry status | output: text or json |
xianyun_config_print expands variables, including any environment variable the config references, and prints the result. Don’t point it at a config you don’t trust. See Security.
State-changing
These run without a prompt.
| Tool | Command | Flags |
|---|---|---|
xianyun_up | xianyun up | none |
xianyun_deploy | xianyun deploy | repo (string, a deployer name), update (boolean, pull repositories first) |
xianyun_update | xianyun update | verify_only, quiet, stash (booleans), repo, skip (strings) |
xianyun_set-kube-context | xianyun set-kube-context | dry_run, remove, use_context (booleans), kubeconfig (string) |
xianyun_config_migrate | xianyun config migrate | dry_run, force, skip_backup (booleans) |
xianyun_registry_start | xianyun registry start | none |
xianyun_registry_stop | xianyun registry stop | none |
xianyun_ca_inspect | xianyun ca inspect | none. Creates the CA key pair on first use. |
xianyun_config_migrate currently only reports that a version 2 configuration is already the latest.
Gated
These need confirmation before they run.
| Tool | Command | What the prompt warns about |
|---|---|---|
xianyun_down | xianyun down | Stops the cluster |
xianyun_destroy | xianyun destroy | Deletes the cluster and all its data, and can’t be undone |
xianyun_update-etc-hosts | xianyun update-etc-hosts | Rewrites /etc/hosts. Flags: dry_run, remove (booleans), ip (string). Typically needs sudo. |
xianyun_ca_trust | xianyun ca trust | Installs the dev CA in the system trust store |
xianyun_ca_untrust | xianyun ca untrust | Removes it |
Gating applies to a dry run too. xianyun_update-etc-hosts with dry_run set still goes through the prompt.
Names with dashes
xianyun_update-etc-hosts and xianyun_set-kube-context keep the dash from the command name, so they’re the only two tool names that aren’t plain identifiers. If your client can’t call them, check how it lists them.