quint-cli

Quint CLI

Maintainer: Gee-Him Siu [e-mail]

Introduction

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.

Requirements

• NPM
• oclif installed globally (optional for generating commands)
• (optional)Makensis for building / packing to windows
  • 7z

Contribution

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.

Steps

Firstly, get the repo cloned onto your machine, you can then start creating a new cli command!

Run repo

• npm run setup
• npm start (This will start nodemon which will check file changes and compile accordingly)

Working on repo

• Work on a new branch using normal git naming conventions
• Create a new command using the oclif command oclif generate command {folder/name}
• Write your tests
• Write your command
• Make sure your tests pass by running npm run test
• Put in a pull request once tests pass and commands done
• You can generate auto documentation using oclif readme

• Introduction
• Requirements
• Contribution
• Usage
• Commands

Usage

$ npm install -g quint-cli
$ quint COMMAND
running command...
$ quint (--version)
quint-cli/0.10.3 darwin-arm64 node-v17.6.0
$ quint --help [COMMAND]
USAGE
  $ quint COMMAND
...

Commands

• quint build
• quint docker artisan [COMMAND]
• quint docker build [FILE]
• quint docker composer [COMMAND]
• quint docker npm [COMMAND]
• quint docker start
• quint docker stop [FILE]
• quint example exec
• quint help [COMMAND]
• quint plugins
• quint plugins:inspect PLUGIN...
• quint plugins:install PLUGIN...
• quint plugins:link PLUGIN
• quint plugins:uninstall PLUGIN...
• quint plugins update
• quint setup
• quint start
• quint stop
• quint system system [FILE]

quint build

Build/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 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 build [FILE]

describe the command here

USAGE
  $ quint docker build [FILE] [-n <value>] [-f]

FLAGS
  -f, --force
  -n, --name=<value>  name to print

DESCRIPTION
  describe the command here

EXAMPLES
  $ quint docker build

quint docker composer [COMMAND]

Acts as a passthrough to run composer commands on the app

USAGE
  $ quint docker composer [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 composer commands on the app

EXAMPLES
  $ quint docker composer

quint docker npm [COMMAND]

Acts as a passthrough to run npm commands on the app

USAGE
  $ quint docker npm [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 npm commands on the app

EXAMPLES
  $ quint docker npm

quint docker start

Start 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 exec

This 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 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 plugins

List 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: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 PLUGIN

Links 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 update

Update installed plugins.

USAGE
  $ quint plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

quint setup

Install 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 start

Start up containers for project

USAGE
  $ quint start

DESCRIPTION
  Start up containers for project

EXAMPLES
  $ quint start

See code: dist/commands/start.ts

quint stop

Stop 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