Skip to main content

Common commands

While there are many commands available, there are some common commands that are used to manage services.

run​

The yeet run command is used to run a service. For a list of the different types of services you can run, see our guide on running services.

yeet run myservice mybinary

logs​

The yeet logs command is used to view the logs for a service.

yeet logs myservice

status​

The yeet status command is used to view the status of a service.

If you run the command without any arguments, it will show the status of all services.

yeet status

If you want to see the status of a specific service, you can pass the service name as an argument.

yeet status myservice

start/stop/restart​

The yeet start, yeet stop, and yeet restart commands are used to start, stop, and restart a service.

yeet start myservice
yeet stop myservice
yeet restart myservice

edit​

The yeet edit command is used to edit a service configuration. This will either be the internal service configuration or a docker-compose.yml file, depending on the type of service.

yeet edit myservice
tip

The edit command runs on your remote Catch server. You can change the editor by editing Catch's environment variables.

yeet edit catch --env

Set the EDITOR environment variable to your preferred editor. Be sure the editor is available on your Catch server. For more information on editing environment variables, see our guide on environment variables.

remove​

The yeet remove command is used to remove a service. This will remove everything associated with the service from the Catch server. This includes the service itself, and its data/ directory and any images associated with it.

yeet remove myservice