GREYTAPE
demo
- Install greytape cli
npm i -g greytape-demo - Go to the desktop folder:
cd ~/Desktop - Create new directory with demo name:
mkdir demo && cd demo - Create yaml file:
touch greytape.yml - Add config content in yaml file (find yaml file example in github)
- Generate your cli:
greytape g <cli-name> - Test your cli
- Go to the folder of your cli:
cd cli-<cli-name> - Install dependencies:
npm i - Show command list:
node <cli-name>.js
config
vars: # OPTIONAL name: value # only string name2: value2 actions: # REQUIRE - name: create nginx api # name of action command: up # command in cli for action alias: u # OPTIONAL shot command prefix: # OPTIONAL add this command in group of command description: # OPTIONAL description of command arg: # OPTIONAL argument passed to the command name: command # the name of the variable where one assign arg description: command exec in container # OPTIONAL argument description in cli default: ping google.com # OPTIONAL default value of arg options: # OPTIONAL option passed to the command - name: port # the name of the variable where one assign option value and option in cli to be use alias: p # OPTIONAL short cli option value: "9090" # OPTIONAL default option value description: port extern # OPTIONAL option description in cli register: # OPTIONAL variable create from an action - name: user # the name of the variable where one assign value return by command command: printenv USER # command executed to get the value pwd: "/" # OPTIONAL context for the execution of the command exec: # array of command executed - cmd: npm run build # command executed cwd: ./frontend # OPTIONAL context for the execution of the command prefix: # OPTIONAL - name: api # group command name description: action on api container # OPTIONAL group description in cli alias: a # OPTIONAL group short command name todo
-
vars add array or object
-
add type boolean, number and ...
-
option without value (-i)
- name: tty alias: i description: tty interaction value: -it default: -itin code
foroption of options if optsoptionname if optionvalue varsoptionname = optionvalue else varsoptionname = optsoptionname else if optiondefault varsoptionname = optiondefault