admin-cli
Simple command line tool to help with the installation and running of Adhara components
Usage
After cloning/installing the tool, running any command (for ex. ./bin/run --help or adhara --help) once will create a configuration template in ~/.config/adhara/config.json if it does not yet exist. You will probably need to edit this (update the installation dir values) to get any of the commands to work. You can point to any other configuration file by setting the ADHARA_CONFIG environment variable.
$ npm install -g admin-cli$ adhara COMMANDrunning command...$ adhara (-v|--version|version)admin-cli/0.0.33 linux-x64 node-v10.15.3$ adhara --help [COMMAND]USAGE $ adhara COMMAND...Commands
adhara cmd COMPONENT CMDadhara dockerize COMPONENTadhara git-clone [COMPONENT]adhara git-log [COMPONENT]adhara git-log-diff [COMPONENT]adhara git-status [COMPONENT]adhara help [COMMAND]adhara kill [COMPONENT]adhara listadhara npm-install [COMPONENT]adhara restart [COMPONENT]adhara set-root DIRECTORYadhara start [COMPONENT]adhara stop [COMPONENT]
adhara cmd COMPONENT CMD
Run a custom command against one or more components.
USAGE
$ adhara cmd COMPONENT CMD
ARGUMENTS
COMPONENT [default: *] component(s) to run command against
CMD custom command name (if defined) or string to execute
OPTIONS
-c, --config=individual|local [default: local] configuration to use
-d, --dependencies
DESCRIPTION
First checks if a specified string is a named command in the configuration, if not, tries to run it in the
installation directory of the component.
...
Extra documentation goes here
See code: src/commands/cmd.js
adhara dockerize COMPONENT
Create and publish a docker image of a specific component.
USAGE
$ adhara dockerize COMPONENT
ARGUMENTS
COMPONENT component to dockerize
OPTIONS
-l, --latest Make this the docker image have the `latest` tag
-p, --push Push the created images to hub.docker.com
DESCRIPTION
...
Extra documentation goes here
See code: src/commands/dockerize.js
adhara git-clone [COMPONENT]
Clone one or more git repositories specified in the config file. This is equivalent to 'git clone '.
USAGE
$ adhara git-clone [COMPONENT]
ARGUMENTS
COMPONENT [default: *] component(s) to run command against
OPTIONS
-d, --dependencies
DESCRIPTION
...
Extra documentation goes here
See code: src/commands/git-clone.js
adhara git-log [COMPONENT]
Report on the repository commit log of one or more components. This is equivalent to 'git log -n 1'.
USAGE
$ adhara git-log [COMPONENT]
ARGUMENTS
COMPONENT [default: *] component(s) to run command against
OPTIONS
-d, --dependencies
DESCRIPTION
...
Extra documentation goes here
See code: src/commands/git-log.js
adhara git-log-diff [COMPONENT]
Report on the difference between remote and local repositories for one or more components. This is equivalent to 'git fetch upstream' followed by 'git log master..upstream/master'.
USAGE
$ adhara git-log-diff [COMPONENT]
ARGUMENTS
COMPONENT [default: *] component(s) to run command against
OPTIONS
-d, --dependencies
DESCRIPTION
...
Extra documentation goes here
See code: src/commands/git-log-diff.js
adhara git-status [COMPONENT]
Report on the repository status of one or more components. This is equivalent to 'git status'.
USAGE
$ adhara git-status [COMPONENT]
ARGUMENTS
COMPONENT [default: *] component(s) to run command against
OPTIONS
-d, --dependencies
DESCRIPTION
...
Extra documentation goes here
See code: src/commands/git-status.js
adhara help [COMMAND]
display help for adhara
USAGE
$ adhara help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
adhara kill [COMPONENT]
Stop and delete/remove one or more processes running in pm2 and/or docker. This is equivalent to 'pm2 delete ' and/or 'docker-compose down'.
USAGE
$ adhara kill [COMPONENT]
ARGUMENTS
COMPONENT [default: *] component(s) to run command against
OPTIONS
-c, --config=individual|local [default: local] configuration to use
-d, --dependencies
DESCRIPTION
...
(extra doc)
See code: src/commands/kill.js
adhara list
List all the processes running in pm2 and docker. This is equivalent to 'pm2 list' and 'docker ps -a'.
USAGE
$ adhara list
DESCRIPTION
...
(extra doc)
See code: src/commands/list.js
adhara npm-install [COMPONENT]
Update npm dependencies for one or more components. This is equivalent to npm install.
USAGE
$ adhara npm-install [COMPONENT]
ARGUMENTS
COMPONENT [default: *] component(s) to run command against
OPTIONS
-d, --dependencies
DESCRIPTION
...
Extra documentation goes here
See code: src/commands/npm-install.js
adhara restart [COMPONENT]
Restart one or more processes running in pm2 and/or docker.
USAGE
$ adhara restart [COMPONENT]
ARGUMENTS
COMPONENT [default: *] component(s) to run command against
OPTIONS
-c, --config=individual|local [default: local] configuration to use
-d, --dependencies
-r, --restart
DESCRIPTION
...
Extra documentation goes here
See code: src/commands/restart.js
adhara set-root DIRECTORY
Update the adhara root specified in your config file.
USAGE
$ adhara set-root DIRECTORY
ARGUMENTS
DIRECTORY The root directory containing your adhara components.
DESCRIPTION
...
Extra documentation goes here
See code: src/commands/set-root.js
adhara start [COMPONENT]
Start one or more processes using pm2 and/or docker-compose.
USAGE
$ adhara start [COMPONENT]
ARGUMENTS
COMPONENT [default: *] component(s) to run command against
OPTIONS
-c, --config=individual|local [default: local] configuration to use
-d, --dependencies
-r, --restart
DESCRIPTION
...
(extra doc)
See code: src/commands/start.js
adhara stop [COMPONENT]
Stop one or more processes running in pm2 and/or docker.
USAGE
$ adhara stop [COMPONENT]
ARGUMENTS
COMPONENT [default: *] component to run command against
OPTIONS
-c, --config=individual|local [default: local] configuration to use
-d, --dependencies
DESCRIPTION
...
(extra doc)
See code: src/commands/stop.js