batleforc / dockerdevcli

dockerdevcli

CLI for Docker dev env

• Usage
• Commands

Usage

$ npm install -g @nexiconseils/dockerdevcli
$ dockerdevcli COMMAND
running command...
$ dockerdevcli (-v|--version|version)
@nexiconseils/dockerdevcli/0.1.7 linux-x64 node-v14.15.0
$ dockerdevcli --help [COMMAND]
USAGE
  $ dockerdevcli COMMAND
...

Commands

• dockerdevcli Container
• dockerdevcli Init
• dockerdevcli PhpProject
• dockerdevcli Portainer
• dockerdevcli createandstart
• dockerdevcli glabrunner
• dockerdevcli gulp
• dockerdevcli help [COMMAND]

dockerdevcli Container

Allow the user to interact with the container

USAGE
  $ dockerdevcli Container

OPTIONS
  -n, --name=name  Name of the container

DESCRIPTION
  ...
  Extra documentation goes here

See code: src/commands/Container.js

dockerdevcli Init

Start the DockerEnv (Start Traefik + insert nameserver to your /etc/hosts)

USAGE
  $ dockerdevcli Init

OPTIONS
  -R, --Remove  Remove Container
  -d, --Stop    Stop Portainer
  -u, --Start   Start Portainer

DESCRIPTION
  ...
  The init command add an entry to your hosts file and start a Reverse proxy who automaticaly update direct 
  {ContainerName}.localhost to the choosen container

See code: src/commands/Init.js

dockerdevcli PhpProject

Allow the user to start a Php home made container

USAGE
  $ dockerdevcli PhpProject

OPTIONS
  -R, --Remove         Remove Container
  -d, --Stop           Stop Container
  -f, --folder=folder  Folder who contains the project
  -n, --name=name      name to print
  -p, --port=port      Port of the project, by default 80
  -u, --Start          Start Container

DESCRIPTION
  ...
  The home made php container contains Composer and the Wp-Cli and is based on a PHP 7.4.11 and apache 2 image

See code: src/commands/PhpProject.js

dockerdevcli Portainer

Start Portainer container /! User sudo

USAGE
  $ dockerdevcli Portainer

OPTIONS
  -R, --Remove  Remove Container
  -d, --Stop    Stop Portainer
  -u, --Start   Start Portainer

DESCRIPTION
  ...
  Portainer is a tool that allow the user to control the docker env

See code: src/commands/Portainer.js

dockerdevcli createandstart

Create a container with the image you have choosed

USAGE
  $ dockerdevcli createandstart

OPTIONS
  -c, --ContainerName=ContainerName  name of the container
  -f, --Folder=Folder                Folder to bind (Please remember to pass the fullpath)
  -i, --ImageName=ImageName          name of the image
  -p, --Port=Port                    Exposed port

DESCRIPTION
  ...
  Create a container with the choosen image,name, port and working folder (Remember to pass the fullpath to the folder)

See code: src/commands/createandstart.js

dockerdevcli glabrunner

Command in developement

USAGE
  $ dockerdevcli glabrunner

OPTIONS
  -R, --Remove                       Remove Container
  -c, --ContainerName=ContainerName  name of the GitlabRunner
  -d, --Stop                         Stop glabrunner
  -f, --Folder=Folder                Folder to bind (Please remember to pass the fullpath)
  -o, --Conf                         Configuration
  -u, --Start                        Start glabrunner

DESCRIPTION
  ...
  Extra documentation goes here

See code: src/commands/glabrunner.js

dockerdevcli gulp

Allow the user to launch gulp command

USAGE
  $ dockerdevcli gulp

OPTIONS
  -O, --Old              If the command has to be executed with the old gulp
  -c, --Command=Command  Node command to execute between "
  -f, --Folder=Folder    Folder in which the cli execute the command
  -s, --Shell            Start an interactive shell

DESCRIPTION
  ...
  This command start a one time use docker and erase it after use, this container allow you to have access to all nodejs 
  command

See code: src/commands/gulp.js

dockerdevcli help [COMMAND]

display help for dockerdevcli

USAGE
  $ dockerdevcli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help