satl command reference

SatL: docker-compatible container engine for FreeBSD

$ satl [OPTIONS] <COMMAND>

Command	Description
satl version	Show the SatL version information (client and server)
satl run	Create and run a new container from an image
satl ps	List containers
satl stop	Stop one or more running containers
satl kill	Kill one or more running containers
satl rm	Remove one or more containers
satl wait	Block until one or more containers stop, then print their exit codes
satl logs	Fetch the logs of a container
satl exec	Execute a command in a running container
satl inspect	Return low-level information on containers
satl pull	Download an image from a registry
satl push	Push an image from this node's store to a registry (client-side, like satl build)
satl tag	Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE
satl build	Build a FreeBSD image from a Satlfile into this node's store
satl images	List images
satl volume	Manage volumes
satl network	Manage networks
satl system	Manage SatL itself
satl swarm	Manage the swarm. satl cluster is an accepted alias: the docker verb is kept for compatibility, the alias reads better in SatL's own docs Alias: cluster
satl ca	View and rotate the cluster root CA (docker's swarm ca, as its own verb: certificate operations deserve better than a flag pile)
satl node	Manage swarm nodes
satl compose	Deploy a Compose file as cluster services (stack semantics, not docker compose's).
satl service	Manage services
satl stack	Manage stacks — Docker's docker stack verbs on SatL's compose machinery (a stack is one compose file's services and networks)
satl secret	Manage secrets
satl config	Manage configs

The daemon has its own page.

Global options

Accepted by every satl command.

Option	Description
--host <URL>	Daemon socket to connect to (docker-style URL) Default: unix:///var/run/satl.sock Environment: DOCKER_HOST
-h, --help	Print help
-V, --version	Print version

---

Generated from satl 0.1.0 by make gen. Change it in the SatL source or in overlay/cli.yml, never here.