Stakkr Commands

stakkr

Main CLI Tool that easily create / maintain a stack of services, for example for web development.

Read the configuration file and setup the required services by linking and managing everything for you.

stakkr [OPTIONS] COMMAND [ARGS]...

Options

--version

Show the version and exit.

-c, --config <config>

Set the configuration filename (stakkr.yml by default)

-d, --debug, --no-debug
-v, --verbose

console

Enter a container to perform direct actions such as install packages, run commands, etc.

stakkr console [OPTIONS] CONTAINER

Options

-u, --user <user>

User’s name. Valid choices : www-data or root

-t, --tty, --no-tty

Use a TTY

Arguments

CONTAINER

Required argument

exec

Execute a command into a container.

Examples:

  • stakkr -v exec mysql mysqldump -p'$MYSQL_ROOT_PASSWORD' mydb > /tmp/backup.sql
  • stakkr exec php php -v : Execute the php binary in the php container with option -v
  • stakkr exec apache service apache2 restart
stakkr exec [OPTIONS] CONTAINER COMMAND...

Options

-u, --user <user>

User’s name. Be careful, each container have its own users.

-t, --tty, --no-tty

Use a TTY

-w, --workdir <workdir>

Working directory

Arguments

CONTAINER

Required argument

COMMAND

Required argument(s)

restart

Restart all (or a single as CONTAINER) container(s)

stakkr restart [OPTIONS] [CONTAINER]

Options

-p, --pull

Force a pull of the latest images versions

-r, --recreate

Recreate all containers

-P, --proxy, --no-proxy

Restart the proxy

Arguments

CONTAINER

Optional argument

services

List available services available for stakkr.yml (with info if the service is enabled)

stakkr services [OPTIONS]

services-add

Download a pack of services from github (see github) containing services. PACKAGE is the git url or package name. NAME is the directory name to clone the repo.

stakkr services-add [OPTIONS] PACKAGE [NAME]

Arguments

PACKAGE

Required argument

NAME

Optional argument

services-update

Update all services packs in services/

stakkr services-update [OPTIONS]

start

Start all (or a single as CONTAINER) container(s) defined in compose.ini

stakkr start [OPTIONS] [CONTAINER]

Options

-p, --pull

Force a pull of the latest images versions

-r, --recreate

Recreate all containers

-P, --proxy, --no-proxy

Start proxy

Arguments

CONTAINER

Optional argument

status

Display a list of running containers

stakkr status [OPTIONS]

stop

Stop all (or a single as CONTAINER) container(s)

stakkr stop [OPTIONS] [CONTAINER]

Options

-P, --proxy, --no-proxy

Stop the proxy

Arguments

CONTAINER

Optional argument