Kuzco CLI

Getting Started

To install and start using Kuzco CLI on Linux or macOS, run the following command:

sh -c "$(curl -sSL https://kuzco.xyz/setup-kuzco.sh)"

Versioning and Updating

Kuzco CLI provides several methods of updating including automatic updating with running Kuzco CLI as a systemd service. See "Managing Kuzco with systemd"

Check Version

kuzco version

Upgrade the Kuzco CLI to latest version

kuzco upgrade

Managing Kuzco with systemd

Kuzco CLI provides several commands to manage the worker running in systemd.

Starting a Worker

To start your worker and install it into systemd, use the following command with the --background flag, which will install the kuzco.service in your systemd:

sudo kuzco worker start --background --worker <worker> --code <code>

There is an optional --follow flag also which will output the worker logs if ran with --background

Checking Worker Status

To check the status of the Kuzco worker in systemd, run:

kuzco worker status

Stopping a Worker

To stop the running Kuzco worker in systemd, use:

sudo kuzco worker stop

Restarting a Worker

To restart the running Kuzco worker in systemd, execute:

sudo kuzco worker restart

Viewing Worker Logs

To view the current running logs of Kuzco in systemd, you can use:

sudo kuzco worker logs

Kuzco Worker Command Usage

For a quick reference on how to manage Kuzco workers, see the command usage below:

kuzco worker help
Usage: kuzco worker [options] [command]

Manage Kuzco workers

Options:
  -h, --help       display help for command

Commands:
  create           Create and register a new worker with Kuzco.
  start [options]  Start a worker
  stop             Stop the Kuzco worker systemd service
  restart          Restart the Kuzco worker systemd service
  status           Check the status of the Kuzco worker
  logs             Get the logs of the Kuzco worker
  clean [options]  kuzco worker clean will remove the current worker and restart the worker service
  help [command]   display help for command