0.0.3 • Published 5 years ago

@alaka/badger v0.0.3

Weekly downloads
-
License
MIT
Repository
-
Last release
5 years ago

badger

Pipefy CLI utility

oclif Version Downloads/week License

Usage

$ npm install -g @alaka/badger
$ bgr COMMAND
running command...
$ bgr (-v|--version|version)
@alaka/badger/0.0.3 darwin-x64 node-v11.12.0
$ bgr --help [COMMAND]
USAGE
  $ bgr COMMAND
...

Commands

bgr autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ bgr autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ bgr autocomplete
  $ bgr autocomplete bash
  $ bgr autocomplete zsh
  $ bgr autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

bgr bye

Describe the command here

USAGE
  $ bgr bye

OPTIONS
  -n, --name=name  name to print

DESCRIPTION
  ...
  Extra documentation goes here

bgr check [CHECK] [DELETE]

Checks and fixes pipefy tables for bad records

USAGE
  $ bgr check [CHECK] [DELETE]

ARGUMENTS
  CHECK   check specified table for problems
  DELETE  deletes broken records

OPTIONS
  -h, --help                 show CLI help
  -o, --org=org              ID of the pipefy organization to use
  -p, --pipefyKey=pipefyKey  (required) API key to use for pipefy, can be set as environment variable PIPEFY_KEY
  -t, --table=table          ID of the table to check

EXAMPLES
  $ check -table '2355' -pipefyKey 'afafaf'
  $ check -org '2355' -pipefyKey 'afafaf'
  $ check delete -table '2355'

bgr commands

list all the commands

USAGE
  $ bgr commands

OPTIONS
  -h, --help  show CLI help
  -j, --json  output in json format
  --hidden    also show hidden commands

See code: @oclif/plugin-commands

bgr hello

Describe the command here

USAGE
  $ bgr hello

OPTIONS
  -n, --name=name  name to print

DESCRIPTION
  ...
  Extra documentation goes here

bgr help [COMMAND]

display help for bgr

USAGE
  $ bgr help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

bgr import PLAN

Imports data based on an import plan and a user provided excel spreadsheet

USAGE
  $ bgr import PLAN

ARGUMENTS
  PLAN  file with import plan to specify import parameters

OPTIONS
  -c, --checkonly            checks the import plan for validity without any data import
  -d, --data=data            specify the data file to use, will ignore the data file in importPlan
  -h, --help                 show CLI help

  -o, --orgID=orgID          specifies into which pipefy organization to import the data, will ignore the one in import
                             plan

  -p, --pipefyKey=pipefyKey  specifies which pipefy API key to use, will ignore the one in import plan

  -v, --verbose              provides more insight into the activities of the scripts

EXAMPLES
  $ import plan 'importPlan.json'
  $ import plan 'importPlan.json' --checkonly
  $ import plan 'importPlan.json' -data='data.xlxs'
  $ import plan 'importPlan.json' -v'

bgr update [CHANNEL]

update the bgr CLI

USAGE
  $ bgr update [CHANNEL]

See code: @oclif/plugin-update

bgr which COMMAND

show which plugin a command is in

USAGE
  $ bgr which COMMAND

See code: @oclif/plugin-which