Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/batleforc/dockerdevcli
https://github.com/batleforc/dockerdevcli
Last synced: 12 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/batleforc/dockerdevcli
- Owner: batleforc
- Created: 2020-10-21T09:05:32.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-11-16T14:03:45.000Z (about 4 years ago)
- Last Synced: 2024-04-26T00:10:01.808Z (9 months ago)
- Language: JavaScript
- Size: 329 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
dockerdevcli
============
CLI for Docker dev env
[](https://oclif.io)
[](https://npmjs.org/package/dockerdevcli)
[](https://npmjs.org/package/dockerdevcli)
[](https://github.com/batleforc/dockerdevcli/blob/master/package.json)
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ 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-container)
* [`dockerdevcli Init`](#dockerdevcli-init)
* [`dockerdevcli PhpProject`](#dockerdevcli-phpproject)
* [`dockerdevcli Portainer`](#dockerdevcli-portainer)
* [`dockerdevcli createandstart`](#dockerdevcli-createandstart)
* [`dockerdevcli glabrunner`](#dockerdevcli-glabrunner)
* [`dockerdevcli gulp`](#dockerdevcli-gulp)
* [`dockerdevcli help [COMMAND]`](#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](https://github.com/batleforc/dockerdevcli/blob/v0.1.7/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](https://github.com/batleforc/dockerdevcli/blob/v0.1.7/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](https://github.com/batleforc/dockerdevcli/blob/v0.1.7/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](https://github.com/batleforc/dockerdevcli/blob/v0.1.7/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](https://github.com/batleforc/dockerdevcli/blob/v0.1.7/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](https://github.com/batleforc/dockerdevcli/blob/v0.1.7/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](https://github.com/batleforc/dockerdevcli/blob/v0.1.7/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](https://github.com/oclif/plugin-help/blob/v3.2.0/src/commands/help.ts)_