Zicode NPM | npm.io

zicode

zicode cli

Usage
Commands

Usage

$ npm install -g zicode
$ zicode COMMAND
running command...
$ zicode (-v|--version|version)
zicode/0.0.13 darwin-x64 node-v10.16.3
$ zicode --help [COMMAND]
USAGE
  $ zicode COMMAND
...

Commands

zicode app
zicode app:restart
zicode app:start
zicode app:status
zicode app:stop
zicode base
zicode base:build
zicode base:pull FRAMEWORK
zicode base:push
zicode connect
zicode connect:start [TARGET]
zicode connect:status
zicode connect:stop
zicode cron
zicode cron:build [FILE]
zicode cron:start
zicode cron:status
zicode cron:stop
zicode db
zicode db:create
zicode db:exec COMMAND
zicode db:logs
zicode db:sql
zicode db:start
zicode db:status
zicode db:stop
zicode docker
zicode docker:exec
zicode docker:leader ADDRESS
zicode docker:logout
zicode docker:restart
zicode docker:start
zicode docker:stop
zicode env
zicode framework
zicode framework:build
zicode framework:install
zicode help [COMMAND]
zicode language
zicode language:delete
zicode language:install
zicode lesson
zicode lesson:build
zicode lesson:clean
zicode lesson:cloud9 INSTANCE USER PASSWORD
zicode lesson:compose
zicode lesson:container INSTANCE SERVICE
zicode lesson:delete INSTANCE
zicode lesson:exec INSTANCE SERVICE [COMMAND]
zicode lesson:install
zicode lesson:list
zicode lesson:pull FRAMEWORK LESSON INSTANCE
zicode lesson:push
zicode lesson:start INSTANCE PORT
zicode lesson:status INSTANCE
zicode lesson:stop INSTANCE
zicode lesson:sync INSTANCE SERVICE PORT
zicode metrics
zicode monitor
zicode monitor:start
zicode monitor:status
zicode monitor:stop [FILE]
zicode network
zicode network:start
zicode network:stop
zicode proxy
zicode proxy:bash
zicode proxy:build [FILE]
zicode proxy:exec COMMAND
zicode proxy:restart
zicode proxy:start
zicode proxy:status
zicode proxy:stop
zicode registry
zicode registry:label
zicode registry:login
zicode registry:logs
zicode registry:start
zicode registry:status
zicode registry:stop
zicode secret
zicode secret:create NAME
zicode secret:list
zicode user
zicode user:activate [FILE]
zicode user:add EMAIL
zicode user:delete EMAIL
zicode user:list
zicode user:paswd EMAIL PASSWORD
zicode user:reset [FILE]
zicode user:suspend [FILE]
zicode web
zicode web:bash
zicode web:build [FILE]
zicode web:convolute [TARGET]
zicode web:exec COMMAND
zicode web:logs
zicode web:migrate
zicode web:push
zicode web:start
zicode web:status
zicode web:stop
zicode web:tag
zicode web:tinker
zicode workbench
zicode workbench:bash
zicode workbench:build [FILE]
zicode workbench:docker
zicode workbench:exec
zicode workbench:start
zicode workbench:status
zicode workbench:stop

`zicode app`

Sub-Command to control the ZiCode App

USAGE
  $ zicode app

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode app:restart`

Restart the zicode stack

USAGE
  $ zicode app:restart

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode app:start`

Deploy zicode to a docker swarm

USAGE
  $ zicode app:start

OPTIONS
  -e, --dotenv=dotenv      use .env file from a path
  -h, --help               print this help
  -i, --identity=identity  identity file to use while convoluting
  -q, --[no-]quiet         do not panic if you do not file an env file
  -s, --silent             shut up
  -v, --verbose            show debug info
  --compose=compose        use an extra compose file
  --convolute              convolute the web service after starting it
  --[no-]deploy            the actual deployment
  --[no-]newline           separate output with new line instead of space
  --repo=repo              repository prefix for images in compose.yml
  --target=target          convolution targer (default: docker@docker.zisoftonline.com)
  --[no-]update            update the stack if it is already running
  --url=url                use a custom health check address (default: ui.zisoftonline.com/app)
  --[no-]wait              wait for the app to come up

`zicode app:status`

Show status of web service on docker swarm

USAGE
  $ zicode app:status

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode app:stop`

Undeploy zicode from a docker swarm

USAGE
  $ zicode app:stop

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  -w, --wait           do not wait for stack to shutdown
  --[no-]newline       separate output with new line instead of space

`zicode base`

Sub-Command to control base images

USAGE
  $ zicode base

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode base:build`

Build a base image

USAGE
  $ zicode base:build

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]cache         use cahce for docker builds
  --[no-]newline       separate output with new line instead of space
  --push               push after building
  --recursive          build parent images first

`zicode base:pull FRAMEWORK`

Pull a base

USAGE
  $ zicode base:pull FRAMEWORK

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -f, --force          delete and reclone if it already exists
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode base:push`

Push a base image

USAGE
  $ zicode base:push

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode connect`

Sub-Command to control SSH connection to docker swarm

USAGE
  $ zicode connect

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode connect:start [TARGET]`

Start SSH Tunnel from localhost:2374 to docker engine (defaults to docker@docker.zisoftonline.com) and give me a shell

USAGE
  $ zicode connect:start [TARGET]

OPTIONS
  -e, --dotenv=dotenv      use .env file from a path
  -h, --help               print this help
  -i, --identity=identity  ssh private key file
  -q, --[no-]quiet         do not panic if you do not file an env file
  -s, --silent             shut up
  -v, --verbose            show debug info
  --[no-]close             close the tunnel when bash exists
  --interactive            give me a bash
  --[no-]newline           separate output with new line instead of space
  --[no-]strict            strict host key checking

  --[no-]tunnel            open an ssh tunnel from localhost:2374 to docker engine (defaults to ' +
                           docker@docker.zisoftonline.com if no target is specified)

`zicode connect:status`

Show status of SSH connection

USAGE
  $ zicode connect:status

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode connect:stop`

Stop SSH Tunnel from localhost:2374

USAGE
  $ zicode connect:stop

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space
  --[no-]posix         use POSIX style for ps

`zicode cron`

Sub-Command to control the cron module

USAGE
  $ zicode cron

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode cron:build [FILE]`

build the cron module

USAGE
  $ zicode cron:build [FILE]

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]cache         use docker cache
  --[no-]newline       separate output with new line instead of space
  --path=path          override the default path module/cron

`zicode cron:start`

start the cron module

USAGE
  $ zicode cron:start

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space
  --registry           use the zicode registry

`zicode cron:status`

status of the cron service

USAGE
  $ zicode cron:status

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode cron:stop`

stop the cron service

USAGE
  $ zicode cron:stop

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode db`

Sub-Command to control zicode database

USAGE
  $ zicode db

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode db:create`

Create the zicode db

USAGE
  $ zicode db:create

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --docker             the database is running inside the zicode swarm stack
  --[no-]newline       separate output with new line instead of space

`zicode db:exec COMMAND`

docker exec into db container

USAGE
  $ zicode db:exec COMMAND

ARGUMENTS
  COMMAND  the command to execute inside the container

OPTIONS
  -d, --daemon         exec command with -d option (run as daemon)
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -i, --interactive
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -t, --tty
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode db:logs`

Display DB docker service logs

USAGE
  $ zicode db:logs

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -f, --follow
  -h, --help           print this help
  -n, --num=num        number of log lines to show
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode db:sql`

sql into db container

USAGE
  $ zicode db:sql

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode db:start`

Start the db module

USAGE
  $ zicode db:start

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space
  --port=port          [default: 3306] use a specific publish port
  --publish            publish the db port
  --registry           use the zicode registry

DESCRIPTION
  The Database will use the following environment variables
  DB_USERNAME_USER,
  DB_DATABASE,
  DB_PASSWORD,
  DB_ROOT_PASSWORD

`zicode db:status`

Show status of zicode database

USAGE
  $ zicode db:status

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode db:stop`

stop the db service

USAGE
  $ zicode db:stop

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode docker`

Sub-Command to control docker

USAGE
  $ zicode docker

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode docker:exec`

Execute a command on the DIND container (only works from inside the swarm)

USAGE
  $ zicode docker:exec

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode docker:leader ADDRESS`

Find the first swarm leader (only works from outside the swarm)

USAGE
  $ zicode docker:leader ADDRESS

ARGUMENTS
  ADDRESS  (ip|name) [default: name] type of address to print

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode docker:logout`

logout to docker registry (only works from inside the swarm)

USAGE
  $ zicode docker:logout

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode docker:restart`

Restart the DIND container (only works from outside the swarm)

USAGE
  $ zicode docker:restart

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode docker:start`

Start the DIND container (only works from outside the swarm)

USAGE
  $ zicode docker:start

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode docker:stop`

Stop the DIND container (only works from outside the swarm)

USAGE
  $ zicode docker:stop

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode env`

Show environment variables and application constants

USAGE
  $ zicode env

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode framework`

Sub-Command to control frameworks

USAGE
  $ zicode framework

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode framework:build`

Build a base image

USAGE
  $ zicode framework:build

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]cache         use cahce for docker builds
  --[no-]newline       separate output with new line instead of space
  --push               push after building

`zicode framework:install`

Install a framework from inside the web container to the connected DB

USAGE
  $ zicode framework:install

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode help [COMMAND]`

display help for zicode

USAGE
  $ zicode help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

`zicode language`

Sub-Command to control Languages

USAGE
  $ zicode language

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode language:delete`

Install a framework from inside the web container to the connected DB

USAGE
  $ zicode language:delete

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode language:install`

Install a framework from inside the web container to the connected DB

USAGE
  $ zicode language:install

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode lesson`

Sub-Command to control lessons

USAGE
  $ zicode lesson

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode lesson:build`

Build a lesson

USAGE
  $ zicode lesson:build

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]cache         use cahce for docker builds
  --[no-]newline       separate output with new line instead of space
  --[no-]panic         panic with the first build error
  --push               push after building
  --recursive          build parent images first

`zicode lesson:clean`

Clean a lesson directory

USAGE
  $ zicode lesson:clean

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode lesson:cloud9 INSTANCE USER PASSWORD`

Start the cloud9 server in a lesson

USAGE
  $ zicode lesson:cloud9 INSTANCE USER PASSWORD

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode lesson:compose`

Build a lesson

USAGE
  $ zicode lesson:compose

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]cache         use cahce for docker builds
  --[no-]newline       separate output with new line instead of space

`zicode lesson:container INSTANCE SERVICE`

Get container id of a lesson

USAGE
  $ zicode lesson:container INSTANCE SERVICE

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode lesson:delete INSTANCE`

delete a lesson instance

USAGE
  $ zicode lesson:delete INSTANCE

OPTIONS
  -d, --del            delete the instance directory
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode lesson:exec INSTANCE SERVICE [COMMAND]`

Docker exec into a lesson container

USAGE
  $ zicode lesson:exec INSTANCE SERVICE [COMMAND]

ARGUMENTS
  INSTANCE
  SERVICE
  COMMAND   command to execute (defaults to sh)

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -i, --interactive
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -t, --tty
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode lesson:install`

Install a lesson from inside the web container to the connected DB

USAGE
  $ zicode lesson:install

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode lesson:list`

delete a lesson instance

USAGE
  $ zicode lesson:list

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode lesson:pull FRAMEWORK LESSON INSTANCE`

Pull a lesson

USAGE
  $ zicode lesson:pull FRAMEWORK LESSON INSTANCE

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -f, --force          delete and reclone if it already exists
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode lesson:push`

Push a lesson

USAGE
  $ zicode lesson:push

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode lesson:start INSTANCE PORT`

Start a lesson

USAGE
  $ zicode lesson:start INSTANCE PORT

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode lesson:status INSTANCE`

Check status of a lesson

USAGE
  $ zicode lesson:status INSTANCE

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode lesson:stop INSTANCE`

Stop a lesson

USAGE
  $ zicode lesson:stop INSTANCE

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode lesson:sync INSTANCE SERVICE PORT`

Sync with a newly created lesson

USAGE
  $ zicode lesson:sync INSTANCE SERVICE PORT

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode metrics`

Sub-Command to control the metrics module

USAGE
  $ zicode metrics

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode monitor`

Sub-Command to control the swarm visualize service

USAGE
  $ zicode monitor

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode monitor:start`

Install the swarm visualization stack

USAGE
  $ zicode monitor:start

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space
  --registry           use the zicode registry

`zicode monitor:status`

status of the monitor service

USAGE
  $ zicode monitor:status

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode monitor:stop [FILE]`

describe the command here

USAGE
  $ zicode monitor:stop [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

`zicode network`

Sub-Command to control the ZiCode swarm network

USAGE
  $ zicode network

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode network:start`

Install the ZiCode swarm network

USAGE
  $ zicode network:start

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode network:stop`

Delete the ZiCode swarm network

USAGE
  $ zicode network:stop

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode proxy`

Sub-Command to control the proxy module

USAGE
  $ zicode proxy

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode proxy:bash`

bash into proxy container

USAGE
  $ zicode proxy:bash

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode proxy:build [FILE]`

build the web module

USAGE
  $ zicode proxy:build [FILE]

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]cache         use docker cache
  --[no-]newline       separate output with new line instead of space
  --path=path          override the default path module/proxy

`zicode proxy:exec COMMAND`

docker exec into proxy container

USAGE
  $ zicode proxy:exec COMMAND

ARGUMENTS
  COMMAND  the command to execute inside the proxy container

OPTIONS
  -d, --daemon         exec command with -d option (run as daemon)
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -i, --interactive
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -t, --tty
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode proxy:restart`

Restart the zicode stack

USAGE
  $ zicode proxy:restart

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode proxy:start`

start the proxy module

USAGE
  $ zicode proxy:start

OPTIONS
  -e, --dotenv=dotenv      use .env file from a path
  -h, --help               print this help
  -q, --[no-]quiet         do not panic if you do not file an env file
  -s, --silent             shut up
  -v, --verbose            show debug info
  --[no-]https             publish an https port
  --https-port=https-port  [default: 443] use a custom https port (Default 80)
  --[no-]newline           separate output with new line instead of space
  --port=port              [default: 80] use a custom http port (Default 80)
  --registry               use the zicode registry

`zicode proxy:status`

stop the proxy service

USAGE
  $ zicode proxy:status

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode proxy:stop`

stop the proxy service

USAGE
  $ zicode proxy:stop

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode registry`

Sub-Command to control the swarm registry service

USAGE
  $ zicode registry

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode registry:label`

mark the current docker node with label registry=true

USAGE
  $ zicode registry:label

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --delete             delete the label instead of adding it
  --force              delete the storage volume if it already exists
  --[no-]newline       separate output with new line instead of space
  --prune              remove the storage volume

`zicode registry:login`

USAGE
  $ zicode registry:login

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode registry:logs`

Display docker service logs

USAGE
  $ zicode registry:logs

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --follow
  --[no-]newline       separate output with new line instead of space
  --num=num            [default: 10] number of log lines to show

`zicode registry:start`

Install the swarm registry

USAGE
  $ zicode registry:start

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode registry:status`

status of the registry service

USAGE
  $ zicode registry:status

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode registry:stop`

Delete the swarm registry

USAGE
  $ zicode registry:stop

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode secret`

Sub-Command to control secrets

USAGE
  $ zicode secret

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode secret:create NAME`

create application-specific docker secret

USAGE
  $ zicode secret:create NAME

ARGUMENTS
  NAME  (base.domain|db.password|db.root.password|git.key|swarm.key|ssl.crt|ssl.ca|ssl.key|web.env|ssl.bundle) name of
        the secret to add

OPTIONS
  -e, --dotenv=dotenv    use .env file from a path
  -h, --help             print this help
  -q, --[no-]quiet       do not panic if you do not file an env file
  -s, --silent           shut up
  -v, --verbose          show debug info
  --all-env              use all environment variable as value
  --force                remove the secret[s] if it already exists
  --from-env=from-env    use an environment variable as value
  --from-file=from-file  use a file as value
  --line=line            value of the secret from commandline
  --[no-]newline         separate output with new line instead of space

`zicode secret:list`

list all application-specific docker secrets

USAGE
  $ zicode secret:list

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode user`

Sub-Command to control users

USAGE
  $ zicode user

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode user:activate [FILE]`

describe the command here

USAGE
  $ zicode user:activate [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

`zicode user:add EMAIL`

create a zicode user

USAGE
  $ zicode user:add EMAIL

OPTIONS
  -a, --admin
  -e, --dotenv=dotenv      use .env file from a path
  -h, --help               print this help
  -p, --password=password
  -q, --[no-]quiet         do not panic if you do not file an env file
  -s, --silent             shut up
  -v, --verbose            show debug info
  --[no-]newline           separate output with new line instead of space

`zicode user:delete EMAIL`

delete a zicode user

USAGE
  $ zicode user:delete EMAIL

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode user:list`

list users

USAGE
  $ zicode user:list

OPTIONS
  -h, --help  show CLI help

`zicode user:paswd EMAIL PASSWORD`

create a zicode user

USAGE
  $ zicode user:paswd EMAIL PASSWORD

OPTIONS
  -h, --help  show CLI help

`zicode user:reset [FILE]`

describe the command here

USAGE
  $ zicode user:reset [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

`zicode user:suspend [FILE]`

describe the command here

USAGE
  $ zicode user:suspend [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

`zicode web`

Sub-Command to control the web module

USAGE
  $ zicode web

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode web:bash`

bash into web container

USAGE
  $ zicode web:bash

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode web:build [FILE]`

build the web module

USAGE
  $ zicode web:build [FILE]

OPTIONS
  -e, --dotenv=dotenv    use .env file from a path
  -h, --help             print this help
  -q, --[no-]quiet       do not panic if you do not file an env file
  -s, --silent           shut up
  -v, --verbose          show debug info
  --[no-]cache           use docker cache
  --[no-]cache-composer  use composer cache
  --[no-]newline         separate output with new line instead of space
  --path=path            override the default path module/web

`zicode web:convolute [TARGET]`

Start the SSH connection inside the web container

USAGE
  $ zicode web:convolute [TARGET]

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -i, --i=i
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode web:exec COMMAND`

docker exec into web container

USAGE
  $ zicode web:exec COMMAND

ARGUMENTS
  COMMAND  the command to execute inside the web container

OPTIONS
  -d, --daemon         exec command with -d option (run as daemon)
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -i, --interactive
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -t, --tty
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode web:logs`

Display docker service logs

USAGE
  $ zicode web:logs

OPTIONS
  -a, --app            show app log files instead of stdout logs
  -e, --dotenv=dotenv  use .env file from a path
  -f, --follow
  -h, --help           print this help
  -n, --num=num        number of log lines to show
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode web:migrate`

migrate the connected db

USAGE
  $ zicode web:migrate

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode web:push`

Push the web docker images

USAGE
  $ zicode web:push

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -t, --tagged
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode web:start`

Start the web module

USAGE
  $ zicode web:start

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]convolute     convolute after startup
  --[no-]newline       separate output with new line instead of space
  --registry           use the zicode registry

DESCRIPTION
  The web module will read configurations from the following secrets
  zicode.base.domain,
  zicode.db.password,
  zicode.git.key,
  zicode.swarm.key,
  zicode.web.env.
  Use `zicode secret` to create and list secrets

`zicode web:status`

Show status of web service on docker swarm

USAGE
  $ zicode web:status

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode web:stop`

stop the web service

USAGE
  $ zicode web:stop

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode web:tag`

tag web image with the private repo

USAGE
  $ zicode web:tag

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode web:tinker`

tinker into web container

USAGE
  $ zicode web:tinker

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space
  --[no-]tty           use -t with docker exec

`zicode workbench`

Sub-Command to control the workbench module

USAGE
  $ zicode workbench

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode workbench:bash`

bash into workbench container

USAGE
  $ zicode workbench:bash

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode workbench:build [FILE]`

build the workbench module

USAGE
  $ zicode workbench:build [FILE]

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]cache         use docker cache
  --[no-]newline       separate output with new line instead of space
  --path=path          override the default path module/workbench

`zicode workbench:docker`

DELETE ME! Execute a docker command in workbench connected to docker

USAGE
  $ zicode workbench:docker

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space
  --tty

`zicode workbench:exec`

docker exec into workbench container

USAGE
  $ zicode workbench:exec

OPTIONS
  -d, --daemon         exec command with -d option (run as daemon)
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -i, --interactive
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -t, --tty
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode workbench:start`

start the workbench module

USAGE
  $ zicode workbench:start

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --manager            deploy on a swarm manager
  --[no-]newline       separate output with new line instead of space
  --registry           use the zicode registry

`zicode workbench:status`

stop the workbench service

USAGE
  $ zicode workbench:status

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

`zicode workbench:stop`

stop the workbench service

USAGE
  $ zicode workbench:stop

OPTIONS
  -e, --dotenv=dotenv  use .env file from a path
  -h, --help           print this help
  -q, --[no-]quiet     do not panic if you do not file an env file
  -s, --silent         shut up
  -v, --verbose        show debug info
  --[no-]newline       separate output with new line instead of space

oclif