Quint CLI

Maintainer: Gee-Him Siu [email protected]

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.

Installation and usage

Requirements

• node v20.9.0 (Recommend you install using NVM), it maybe backwards compatible however this has not been tested
• AWS creds
• Make sure your repo is compatible, usually if there's a quint.json at the root then you're all good

Steps

if you're installing / running for cloud platform, there are specifc gotchas below

• npm i -g quint-cli
• quint health This will install any missing dependencies you may not have
• aws configure You'll need to input your AWS creds, please ask @monevogee
• Copy over the .env file
• quint setup This will setup everything and run the containers, you will be presented with a ports table, make note of the APPs port. Once everything's ready you can then go to http://localhost:{APP_PORT}

Cloud platform specific steps

• When copying .env, make sure these values are commented out:

MSSQL_DB_CONNECTION=mssql
MSSQL_DB_HOST=100.x.x.x
MSSQL_DB_PORT=1xx3              
MSSQL_DB_DATABASE=xxx_xxx_xxx
MSSQL_DB_USERNAME=xxxxxxx    
MSSQL_DB_PASSWORD=xxxx          

• There are import specifc values you need, this can be shared via lastpass for you to input in your env
• Make sure you're on VPN or you won't be able to download the data

Working on the CLI

Requirements

• NPM
• oclif installed globally (optional for generating commands)

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

Deployments

Lovely helpers

Show full objects on your command line with console log:

const object = {
  foo: 'bar',
}

console.log(util.inspect(object, false, null, true))

• Introduction
• Installation and usage
• Working on the CLI
• Contribution
• Usage
• Commands

Usage

$ npm install -g quint-cli
$ quint COMMAND
running command...
$ quint (--version)
quint-cli/2.8.7 linux-x64 node-v20.9.0
$ quint --help [COMMAND]
USAGE
  $ quint COMMAND
...

Commands

• quint animation
• quint artisan [COMMAND]
• quint build
• quint build image [DOCKERFILE] [NAME] [VERSION]
• quint check
• quint composer [COMMAND]
• quint connect [CONTAINER]
• quint debug [MODE]
• quint deploy [DESTINATION]
• quint deploy aws lambda
• quint docker artisan [COMMAND]
• quint docker build
• quint docker composer [COMMAND]
• quint docker prune
• quint docker start
• quint docker stop
• quint example exec
• quint health
• quint help [COMMANDS]
• quint installer [SERVICE]
• quint notify [ENDPOINT] [BODY]
• quint npm [COMMAND]
• quint nuke
• quint plaza image build
• quint plaza image push
• quint plaza run
• quint plugins
• quint plugins:install PLUGIN...
• quint plugins:inspect PLUGIN...
• quint plugins:install PLUGIN...
• quint plugins:link PLUGIN
• quint plugins:uninstall PLUGIN...
• quint plugins reset
• quint plugins:uninstall PLUGIN...
• quint plugins:uninstall PLUGIN...
• quint plugins update
• quint run [COMMAND]
• quint set [VARIABLE] [VALUE]
• quint setup
• quint start
• quint stop
• quint system system
• quint tester
• quint welcome

quint animation

describe the command here

USAGE
  $ quint animation

DESCRIPTION
  describe the command here

EXAMPLES
  $ quint animation

See code: src/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: src/commands/artisan.ts

quint build

Build/Rebuild project containers and images

USAGE
  $ quint build

DESCRIPTION
  Build/Rebuild project containers and images

EXAMPLES
  $ quint build

See code: src/commands/build.ts

quint build image [DOCKERFILE] [NAME] [VERSION]

Use this command to build an image

USAGE
  $ quint build image [DOCKERFILE] [NAME] [VERSION]

DESCRIPTION
  Use this command to build an image
  by passing in the Dockerfile path i.e. quint build image
  ./Dockerfile

EXAMPLES
  $ quint build image

See code: src/commands/build/image.ts

quint check

describe the command here

USAGE
  $ quint check

DESCRIPTION
  describe the command here

EXAMPLES
  $ quint check

See code: src/commands/check.ts

quint composer [COMMAND]

Acts as a passthrough to run composer commands on the app

USAGE
  $ quint composer [COMMAND]

ARGUMENTS
  COMMAND  Command to run

DESCRIPTION
  Acts as a passthrough to run composer commands on the app

EXAMPLES
  $ quint composer

See code: src/commands/composer.ts

quint connect [CONTAINER]

Pass through to command line inside container

USAGE
  $ quint connect [CONTAINER]

ARGUMENTS
  CONTAINER  The container name

DESCRIPTION
  Pass through to command line inside container

EXAMPLES
  $ quint connect

See code: src/commands/connect.ts

quint debug [MODE]

Set your debug enviornment variable to show console logs

USAGE
  $ quint debug [MODE]

ARGUMENTS
  MODE  Toggle debug on and off manually

DESCRIPTION
  Set your debug enviornment variable to show console logs

EXAMPLES
  $ quint debug

See code: src/commands/debug.ts

quint deploy [DESTINATION]

Deploy repo

USAGE
  $ quint deploy [DESTINATION]

ARGUMENTS
  DESTINATION  Production, QA, development etc

DESCRIPTION
  Deploy repo

EXAMPLES
  $ quint deploy

See code: src/commands/deploy.ts

quint deploy aws lambda

Create / Update / Destory Lambda functions

USAGE
  $ quint deploy aws lambda

DESCRIPTION
  Create / Update / Destory Lambda functions

EXAMPLES
  $ quint deploy aws lambda

See code: src/commands/deploy/aws/lambda.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>]

ARGUMENTS
  COMMAND  What command to run

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

See code: src/commands/docker/artisan.ts

quint docker build

Rebuild / 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

See code: src/commands/docker/build.ts

quint docker composer [COMMAND]

Acts as a passthrough to run composer commands on the app

USAGE
  $ quint docker composer [COMMAND]

ARGUMENTS
  COMMAND  What command to run

DESCRIPTION
  Acts as a passthrough to run composer commands on the app

EXAMPLES
  $ quint docker composer

See code: src/commands/docker/composer.ts

quint docker prune

Remove unused volumes

USAGE
  $ quint docker prune

DESCRIPTION
  Remove unused volumes

EXAMPLES
  $ quint docker prune

See code: src/commands/docker/prune.ts

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

See code: src/commands/docker/start.ts

quint docker stop

Stop docker containers on project

USAGE
  $ quint docker stop

DESCRIPTION
  Stop docker containers on project

EXAMPLES
  $ quint docker stop

See code: src/commands/docker/stop.ts

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

See code: src/commands/example/exec.ts

quint health

Check if you have the neccessary processes needed

USAGE
  $ quint health

DESCRIPTION
  Check if you have the neccessary processes needed

EXAMPLES
  $ quint health

See code: src/commands/health.ts

quint help [COMMANDS]

Display help for quint.

USAGE
  $ quint help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  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 installer [SERVICE]

Install software when it available

USAGE
  $ quint installer [SERVICE]

ARGUMENTS
  SERVICE  Service to be used

DESCRIPTION
  Install software when it available

EXAMPLES
  $ quint installer

See code: src/commands/installer.ts

quint notify [ENDPOINT] [BODY]

describe the command here

USAGE
  $ quint notify [ENDPOINT] [BODY]

ARGUMENTS
  ENDPOINT  Endpoint to send the body to
  BODY

DESCRIPTION
  describe the command here

EXAMPLES
  $ quint notify

See code: src/commands/notify.ts

quint npm [COMMAND]

Run NPM commands to the container

USAGE
  $ quint npm [COMMAND]

ARGUMENTS
  COMMAND  What command to run

DESCRIPTION
  Run NPM commands to the container

EXAMPLES
  $ quint npm

See code: src/commands/npm.ts

quint nuke

Removes 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: src/commands/nuke.ts

quint plaza image build

This is the command used by Docker Plaza to build nightly versions of the base images

USAGE
  $ quint plaza image build

DESCRIPTION
  This is the command used by Docker Plaza to build nightly versions of the base images

EXAMPLES
  $ quint plaza image build

See code: src/commands/plaza/image/build.ts

quint plaza image push

describe the command here

USAGE
  $ quint plaza image push

DESCRIPTION
  describe the command here

EXAMPLES
  $ quint plaza image push

See code: src/commands/plaza/image/push.ts

quint plaza run

Run through all the Plaza configs and start

USAGE
  $ quint plaza run

DESCRIPTION
  Run through all the Plaza configs and start
  building and pushing images to the registry!

EXAMPLES
  $ quint plaza run

See code: src/commands/plaza/run.ts

quint plugins

List installed plugins.

USAGE
  $ quint plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

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.
  -s, --silent   Silences yarn output.
  -v, --verbose  Show verbose yarn output.

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

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ quint plugins:inspect myplugin

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.
  -s, --silent   Silences yarn output.
  -v, --verbose  Show verbose yarn output.

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

See code: @oclif/plugin-plugins

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
  --[no-]install  Install dependencies after linking the plugin.

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

See code: @oclif/plugin-plugins

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 reset

Remove all user-installed and linked plugins.

USAGE
  $ quint plugins reset

See code: @oclif/plugin-plugins

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

See code: @oclif/plugin-plugins

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.

See code: @oclif/plugin-plugins

quint run [COMMAND]

Acts as a passthrough to run a command directly inside the container

USAGE
  $ quint run [COMMAND]

ARGUMENTS
  COMMAND  Command that you want to run

DESCRIPTION
  Acts as a passthrough to run a command directly inside the container

EXAMPLES
  $ quint run

See code: src/commands/run.ts

quint set [VARIABLE] [VALUE]

describe the command here

USAGE
  $ quint set [VARIABLE] [VALUE] [-d]

FLAGS
  -d, --delete  Delete variable if set

DESCRIPTION
  describe the command here

EXAMPLES
  $ quint set

See code: src/commands/set.ts

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: src/commands/setup.ts

quint start

Start up containers for project

USAGE
  $ quint start

DESCRIPTION
  Start up containers for project

EXAMPLES
  $ quint start

See code: src/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: src/commands/stop.ts

quint system system

describe the command here

USAGE
  $ quint system system [-n <value>] [-f]

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

DESCRIPTION
  describe the command here

EXAMPLES
  $ quint system system

See code: src/commands/system/system.ts

quint tester

describe the command here

USAGE
  $ quint tester

DESCRIPTION
  describe the command here

EXAMPLES
  $ quint tester

See code: src/commands/tester.ts

quint welcome

Welcome screen for post install!

USAGE
  $ quint welcome

DESCRIPTION
  Welcome screen for post install!

EXAMPLES
  $ quint welcome

See code: src/commands/welcome.ts