CLI - the yr command

Contents

CLI - the yr command#

yr is the openYuanrong Python deployment and operations CLI, used for component startup, shutdown, status checking, and configuration rendering in host mode.

Lifecycle Commands#

Command	Description
`start`	Start the cluster (`master` or `agent` mode).
`launch`	Start a single component only, typically used for container entrypoint scenarios.
`health`	Read the session file to check the health status of components on the current node.
`status`	View cluster status (only queryable in `master` mode for cluster resource views).
`stop`	Stop daemon/component processes recorded in the session.

Configuration Commands#

Command	Description
`config`	Output merged configuration or built-in configuration templates.

Global Options#

Option	Description
`-c, --config PATH`	Specify the `config.toml` path; defaults to `/etc/yuanrong/config.toml` if not specified.
`-v, --verbose`	Enable DEBUG logging.
`--version`	Output the `yr` version and exit.
`-h, --help`	View help information.

Get Installation Path#

python3 -c "import yr;print(yr.__path__[0])"
# /usr/local/lib/python3.9/site-packages/yr