Kvalifik-CLI

A CLI for all things related to development at Kvalifik.

Installing

Install from the NPM registry, using your prefered package manager.

• npm install -g kvalifik-cli
• yarn global add kvalifik-cli

Run it using one of the binaries:

• kvalifik-cli [COMMAND]
• kvalifik [COMMAND]
• kli [COMMAND]

How to use?

All a project needs is for a kvalifik.config.json to exist in the root directory. It can be created (and/or updated) by running the config init command.

The config acts as a per-project source-of-truth, helping the CLI integrate with Forecast. For example specifying which Forecast column(s) contain backlog tasks, finished tasks etc. This also means that the config might need to be updated, if changes are made to a project's Forecast board.

CLI not working?

If you can't run the CLI using the globally available kvalifik/kli terminal command, it might be because the binary path is not being found. This is most likely because it hasn't been installed in a directory that is on your OS PATH variable. If you installed the CLI using NPM, this should be done by default. Other package managers, such as yarn, might not do this automatically.

In such cases you need to add the package manager's /bin directory to your OS PATH variable.

macOS:

1. Open your shell config (.bashrc, .zshrc, .bash_profile etc.)
2. add export PATH="$(yarn global bin):$PATH"

Windows:

Easily found by googling.

Linux:

Should be similar to the Mac instructions. Also easy to google.

Overview of tooling

• Framework by oclif
• Prompts by @inquirer/core and @inquirer/prompts
• Task system by listr2
• Shell commands through execa.
• OS independant commands through shx
• Terminal links by terminal-link
• Colored output by chalk

Forecast integration

• Uses a GCP deployed, custom built, Forecast API to create tasks (and more) which uses Forecast's official API.
• Uses google-auth-library to authorize API calls to the custom API. This is done through ADC (Application Default Credentials).

Commands

• kvalifik-cli config init
• kvalifik-cli help [COMMAND]
• kvalifik-cli work

kvalifik-cli config init

Initialize kvalifik config file.

USAGE
  $ kvalifik-cli config init [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Initialize kvalifik config file.

ALIASES
  $ kvalifik-cli init

See code: src/commands/config/init.ts

kvalifik-cli help [COMMAND]

Display help for kvalifik-cli.

USAGE
  $ kvalifik-cli 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 kvalifik-cli.

See code: @oclif/plugin-help

kvalifik-cli work

Set up Branch and PR for working on a Forecast task.

USAGE
  $ kvalifik-cli work [-a] [-h]

FLAGS
  -a, --assigned  Only show tasks assigned to you. Optional.
  -h, --help      Show CLI help.

DESCRIPTION
  Set up Branch and PR for working on a Forecast task.

ALIASES
  $ kvalifik-cli w

See code: src/commands/work.ts