@bcgov/nrdk

nrdk

• Prerequisites
• Usage
• Commands

Prerequisites

• Setup yout git CLI so that credentials are being cached. You can use the store or cache credential helper. PS.: Jenkins will do that automatically for you when running within a jenkins job.

Usage

$ npm install -g @bcgov/nrdk
$ nrdk COMMAND
running command...
$ nrdk (-v|--version|version)
@bcgov/nrdk/0.1.0-rc.67 darwin-x64 node-v12.14.1
$ nrdk --help [COMMAND]
USAGE
  $ nrdk COMMAND
...

The CLI can also be run with npx:

$ npx @bcgov/nrdk (-v|--version|version)
$ npx @bcgov/nrdk --help [COMMAND]
USAGE
  $ nrdk COMMAND

Commands

• nrdk backlog:checkin
• nrdk backlog:checkout [ISSUE]
• nrdk help [COMMAND]

nrdk backlog:checkin

Push local changes (commits) to the remote repository

USAGE
  $ nrdk backlog:checkin

OPTIONS
  --pr  Create Pull-Request

See code: src/commands/backlog/checkin.ts

nrdk backlog:checkout [ISSUE]

Create (if required), and checkout the git branch supporting a Jira issue (bug, new feature, improvement, etc...)

USAGE
  $ nrdk backlog:checkout [ISSUE]

ARGUMENTS
  ISSUE  Jira issue key (e.g.: WEBADE-123)

See code: src/commands/backlog/checkout.ts

nrdk help [COMMAND]

display help for nrdk

USAGE
  $ nrdk help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help