kvalifik-cli v2.4.0

kvalifik-cli

A CLI for all things related to development at Kvalifik

Originally built by Frederic Widding frederic@kvalifik.dk

Powered by OCLIF.

Table of Contents

• kvalifik-cli
• Table of Contents
• Contributing
• Usage
• Commands

Contributing

We use the npm package semantic-release for CD. It uses the commit messages to determine the impact of changes in the codebase and automatically determines the next semantic version number, generates a changelog and publishes the release. Read more here. We use husky to manage our git commit hook. This hook prompts you several questions that help with making compliant commit messages. Run npm run prepare to install the git hook in the current directory.

The table below shows which commit message gets you which release type when semantic-release runs (using the default configuration):

Usage

$ npm install -g kvalifik-cli
$ kvalifik-cli COMMAND
running command...
$ kvalifik-cli (-v|--version|version)
kvalifik-cli/2.4.0 linux-x64 node-v14.20.0
$ kvalifik-cli --help [COMMAND]
USAGE
  $ kvalifik-cli COMMAND
...

Commands

• kvalifik-cli help [COMMAND]
• kvalifik-cli ready-for-review
• kvalifik-cli shopify-get-live-settings
• kvalifik-cli shopify-init
• kvalifik-cli shopify-preview-theme
• kvalifik-cli shopify-serve
• kvalifik-cli terraform-service-account
• kvalifik-cli work-on

kvalifik-cli help [COMMAND]

display help for kvalifik-cli

USAGE
  $ kvalifik-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

kvalifik-cli ready-for-review

Marks PR associated with current branch ready for review.

USAGE
  $ kvalifik-cli ready-for-review

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ kvalifik-cli ready-for-review
  $ kvalifik-cli rr

See code: src/commands/ready-for-review.ts

kvalifik-cli shopify-get-live-settings

Fetches settings_data.json from live Shopify theme.

USAGE
  $ kvalifik-cli shopify-get-live-settings

OPTIONS
  -h, --help  show CLI help

See code: src/commands/shopify-get-live-settings.ts

kvalifik-cli shopify-init

Initializes the current working directory as a Shopify project, with all the relevant files required for our workflow

USAGE
  $ kvalifik-cli shopify-init

See code: src/commands/shopify-init.ts

kvalifik-cli shopify-preview-theme

Deploys your branch as a theme, and attaches preview links to the pull request. Ideally run alongside kvalifik ready-for-review.

USAGE
  $ kvalifik-cli shopify-preview-theme

OPTIONS
  -n, --name=name  Overwrites theme name. We default to "Preview Theme: [PR name]". Optional.

See code: src/commands/shopify-preview-theme.ts

kvalifik-cli shopify-serve

Starts a local Shopify instance that watches files, spins up a dev theme and compiles Tailwind/Gulp.

USAGE
  $ kvalifik-cli shopify-serve

OPTIONS
  -h, --help  show CLI help

See code: src/commands/shopify-serve.ts

kvalifik-cli terraform-service-account

Setup Terraform state management

USAGE
  $ kvalifik-cli terraform-service-account

OPTIONS
  -h, --help                     show CLI help
  -n, --projectName=projectName  Project name to use for setup, command will run without prompts with this flag.

ALIASES
  $ kvalifik-cli tf

See code: src/commands/terraform-service-account.ts

kvalifik-cli work-on

Set up Branch and PR for working on a GitHub issue.

USAGE
  $ kvalifik-cli work-on

OPTIONS
  -a, --assigned       Only show issues assigned to you. Boolean, optional

  -b, --branch=branch  Overwrite starting branch. Normally we use the default branch, but sometimes you want to work
                       from another outset, ex Development or Staging. Optional.

  -c, --currentBranch  Overwrite starting branch to current branch. Cannot be used alongside --branch. Boolean,
                       optional.

  -h, --help           show CLI help

  -i, --id=id          ID for GitHub Issue you're working on. Optional.

ALIASES
  $ kvalifik-cli work
  $ kvalifik-cli w
  $ kvalifik-cli wo

See code: src/commands/work-on.ts