CLI reference

This guide provides a reference for the Catch CLI. Catch can be used either by using our client companion, yeet, or by using ssh and scp directly. In the following sections, we'll provide a reference for both methods.

For a list of common commands, see our common commands guide.

cron

Deploy a binary or script to run as a cron job.

yeet cron myservice mybinary "0 0 * * *"
cat mybinary | ssh myservice@catch cron "0 0 * * *"

disable

Disable a service.

yeet disable myservice
ssh myservice@catch disable

enable

Enable a service.

yeet enable myservice
ssh myservice@catch enable

logs

View and follow the logs of a service.

yeet logs myservice
ssh myservice@catch logs

push

yeet push <image> <service>

CATCH_FQDN=catch.foo.ts.net
docker tag <image> ${CATCH_FQDN}/myservice
docker push ${CATCH_FQDN}/myservice

remove

Remove and clean up all files associated with a service.

yeet remove myservice
ssh myservice@catch remove

restart

Restart a service.

yeet restart myservice
ssh myservice@catch restart

run

Deploy and run a service, or update the existing one if it’s already deployed

yeet run myservice mybinary
cat mybinary | ssh myservice@catch run

stage

Stage a service for deployment.

yeet stage myservice mybinary
cat mybinary | ssh myservice@catch stage

# commit the staged configuration
yeet stage myservice commit
ssh myservice@catch stage commit

Other commands are available.

# clear the staged configuration
yeet stage myservice clear
ssh myservice@catch stage clear

# show the staged configuration
yeet stage myservice show
ssh myservice@catch stage show

start

Start a service.

yeet start myservice
ssh myservice@catch start

status

View the status of all service or a specific service.

# view the status of all services
yeet status
ssh sys@catch status

# view the status of a specific service
yeet status myservice
ssh myservice@catch status

stop

Stop a service.

yeet stop myservice
ssh myservice@catch stop

version

View the version of the server.

yeet version
ssh catch version