Skip to content

CLI Configuration

Configuration Options

pockets.toml
endpoint="http://127.0.0.1:3000"

Available Commands

  • create
  • list
  • start
  • stop
  • delete

Create

Creates a new container with the specified name and version

Terminal window
pocketsctl create test-1

Args

nameoptionaldescription
nametruethe name for the container to create

List

Displays a list of existing containers as well as their status (i.e. for how long they have been running)

Terminal window
pocketsctl list

Start

Starts the specified container

Terminal window
pocketsctl start <id_of_the_container>

Args

nameoptionaldescription
idtruethe id of the container to start

Stop

Stops the specified container

Terminal window
pocketsctl stop <id_of_the_container>

Args

nameoptionaldescription
idtruethe id of the container to stop

Delete

Delete the specified container

Terminal window
pocketsctl delete <id_of_the_container>

Args

nameoptionaldescription
idtruethe id of the container to delete
—forcetrueskips asking for confirmation before deleting the container