quint-cli
Advanced tools
Maintainer: Gee-Him Siu gsiu@monevo.com
On our way to standardising a lot of processes in the company, we've created the Quint CLI so that everyone can have a simple way of accessing / booting up different repos with the least friction as possible.
Please do contribute where you can, a list of features and bugs are available over in the JIRA board (Development Operations). Of course any ideas you'd like to input please let the maintainer know.
Firstly, get the repo cloned onto your machine, you can then start creating a new cli command!
npm run setupnpm start (This will start nodemon which will check file changes and compile accordingly)oclif generate command {folder/name}npm run testoclif readme$ npm install -g quint-cli
$ quint COMMAND
running command...
$ quint (--version)
quint-cli/1.1.4 linux-x64 node-v17.6.0
$ quint --help [COMMAND]
USAGE
$ quint COMMAND
...
quint animation [FILE]quint artisan [COMMAND]quint buildquint check [FILE]quint composer [COMMAND]quint connect [CONTAINER]quint deployquint docker artisan [COMMAND]quint docker buildquint docker composer [COMMAND]quint docker prunequint docker startquint docker stop [FILE]quint example execquint healthquint help [COMMAND]quint npm [COMMAND]quint nukequint pluginsquint plugins:install PLUGIN...quint plugins:inspect PLUGIN...quint plugins:install PLUGIN...quint plugins:link PLUGINquint plugins:uninstall PLUGIN...quint plugins:uninstall PLUGIN...quint plugins:uninstall PLUGIN...quint plugins updatequint run [COMMAND]quint setupquint startquint stopquint system system [FILE]quint animation [FILE]describe the command here
USAGE
$ quint animation [FILE] [-n <value>] [-f]
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
describe the command here
EXAMPLES
$ quint animation
See code: dist/commands/animation.ts
quint artisan [COMMAND]Acts as a passthrough to run artisan commands on the app
USAGE
$ quint artisan [COMMAND]
DESCRIPTION
Acts as a passthrough to run artisan commands on the app
EXAMPLES
$ quint artisan
See code: dist/commands/artisan.ts
quint buildBuild/Rebuild project containers and images
USAGE
$ quint build
DESCRIPTION
Build/Rebuild project containers and images
EXAMPLES
$ quint build
See code: dist/commands/build.ts
quint check [FILE]describe the command here
USAGE
$ quint check [FILE] [-n <value>] [-f]
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
describe the command here
EXAMPLES
$ quint check
See code: dist/commands/check.ts
quint composer [COMMAND]Acts as a passthrough to run composer commands on the app
USAGE
$ quint composer [COMMAND]
DESCRIPTION
Acts as a passthrough to run composer commands on the app
EXAMPLES
$ quint composer
See code: dist/commands/composer.ts
quint connect [CONTAINER]Pass through to command line inside container
USAGE
$ quint connect [CONTAINER]
DESCRIPTION
Pass through to command line inside container
EXAMPLES
$ quint connect
See code: dist/commands/connect.ts
quint deployDeploy repo
USAGE
$ quint deploy
DESCRIPTION
Deploy repo
EXAMPLES
$ quint deploy
See code: dist/commands/deploy.ts
quint docker artisan [COMMAND]Acts as a passthrough to run Artisan commands on the app
USAGE
$ quint docker artisan [COMMAND] [-f <value>] [-v <value>]
FLAGS
-f, --framework=<value> Name of framework
-v, --version=<value> Version of framework
DESCRIPTION
Acts as a passthrough to run Artisan commands on the app
EXAMPLES
$ quint docker artisan
quint docker buildRebuild / Build images for containers
USAGE
$ quint docker build [-c <value>] [-s <value>]
FLAGS
-c, --cached=<value> Build using cached images
-s, --secret=<value> Specify build secrests file
DESCRIPTION
Rebuild / Build images for containers
EXAMPLES
$ quint docker build
quint docker composer [COMMAND]Acts as a passthrough to run composer commands on the app
USAGE
$ quint docker composer [COMMAND]
DESCRIPTION
Acts as a passthrough to run composer commands on the app
EXAMPLES
$ quint docker composer
quint docker pruneRemove unused volumes
USAGE
$ quint docker prune
DESCRIPTION
Remove unused volumes
EXAMPLES
$ quint docker prune
quint docker startStart docker containers in detached mode according to framework
USAGE
$ quint docker start [-b] [-b]
FLAGS
-b, --build
-b, --studio
DESCRIPTION
Start docker containers in detached mode according to framework
EXAMPLES
$ quint docker start
quint docker stop [FILE]Stop docker containers on project
USAGE
$ quint docker stop [FILE] [-n <value>] [-f]
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
Stop docker containers on project
EXAMPLES
$ quint docker stop
quint example execThis is an example of calling a system command
USAGE
$ quint example exec
DESCRIPTION
This is an example of calling a system command
EXAMPLES
$ quint example exec
quint healthCheck if you have the neccessary processes needed
USAGE
$ quint health
DESCRIPTION
Check if you have the neccessary processes needed
EXAMPLES
$ quint health
See code: dist/commands/health.ts
quint help [COMMAND]Display help for quint.
USAGE
$ quint help [COMMAND] [-n]
ARGUMENTS
COMMAND Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for quint.
See code: @oclif/plugin-help
quint npm [COMMAND]Run NPM commands to the container
USAGE
$ quint npm [COMMAND] [-f <value>] [-v <value>]
FLAGS
-f, --framework=<value> Name of framework
-v, --version=<value> Version of framework
DESCRIPTION
Run NPM commands to the container
EXAMPLES
$ quint npm
See code: dist/commands/npm.ts
quint nukeRemoves all running containers for specified project and all unused volumes
USAGE
$ quint nuke
DESCRIPTION
Removes all running containers for specified project and all unused volumes
EXAMPLES
$ quint nuke
See code: dist/commands/nuke.ts
quint pluginsList installed plugins.
USAGE
$ quint plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ quint plugins
See code: @oclif/plugin-plugins
quint plugins:install PLUGIN...Installs a plugin into the CLI.
USAGE
$ quint plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ quint plugins add
EXAMPLES
$ quint plugins:install myplugin
$ quint plugins:install https://github.com/someuser/someplugin
$ quint plugins:install someuser/someplugin
quint plugins:inspect PLUGIN...Displays installation properties of a plugin.
USAGE
$ quint plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ quint plugins:inspect myplugin
quint plugins:install PLUGIN...Installs a plugin into the CLI.
USAGE
$ quint plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ quint plugins add
EXAMPLES
$ quint plugins:install myplugin
$ quint plugins:install https://github.com/someuser/someplugin
$ quint plugins:install someuser/someplugin
quint plugins:link PLUGINLinks a plugin into the CLI for development.
USAGE
$ quint plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ quint plugins:link myplugin
quint plugins:uninstall PLUGIN...Removes a plugin from the CLI.
USAGE
$ quint plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ quint plugins unlink
$ quint plugins remove
quint plugins:uninstall PLUGIN...Removes a plugin from the CLI.
USAGE
$ quint plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ quint plugins unlink
$ quint plugins remove
quint plugins:uninstall PLUGIN...Removes a plugin from the CLI.
USAGE
$ quint plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ quint plugins unlink
$ quint plugins remove
quint plugins updateUpdate installed plugins.
USAGE
$ quint plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
quint run [COMMAND]Acts as a passthrough to run a command directly inside the container
USAGE
$ quint run [COMMAND]
DESCRIPTION
Acts as a passthrough to run a command directly inside the container
EXAMPLES
$ quint run
See code: dist/commands/run.ts
quint setupInstall necessary dependencies for project into docker containers
USAGE
$ quint setup
DESCRIPTION
Install necessary dependencies for project into docker containers
EXAMPLES
$ quint setup
See code: dist/commands/setup.ts
quint startStart up containers for project
USAGE
$ quint start
DESCRIPTION
Start up containers for project
EXAMPLES
$ quint start
See code: dist/commands/start.ts
quint stopStop runninng containers associated with this project
USAGE
$ quint stop
DESCRIPTION
Stop runninng containers associated with this project
EXAMPLES
$ quint stop
See code: dist/commands/stop.ts
quint system system [FILE]describe the command here
USAGE
$ quint system system [FILE] [-n <value>] [-f]
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
describe the command here
EXAMPLES
$ quint system system
FAQs
The almightly Quint Cli
The npm package quint-cli receives a total of 29 weekly downloads. As such, quint-cli popularity was classified as not popular.
We found that quint-cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.