Skip to content

jmbeach/bamboo-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

62 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

bamboo-cli

command-line tool to interact with Atlassian Bamboo

oclif Version Downloads/week License

Configuration

The following configuration settings are available:

"*" = required

  • * $ bamboo-cli conf username
  • * $ bamboo-cli conf password
  • * $ bamboo-cli conf url
  • $ bamboo-cli conf tabCount

Usage

$ npm install -g bamboo-cli
$ bamboo-cli COMMAND
running command...
$ bamboo-cli (-v|--version|version)
bamboo-cli/0.0.0 win32-x64 node-v12.14.1
$ bamboo-cli --help [COMMAND]
USAGE
  $ bamboo-cli COMMAND
...
$ npm install -g bamboo-cli
$ bamboo-cli COMMAND
running command...
$ bamboo-cli (-v|--version|version)
bamboo-cli/0.0.0 win32-x64 node-v8.16.2
$ bamboo-cli --help [COMMAND]
USAGE
  $ bamboo-cli COMMAND
...

Commands

bamboo-cli autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ bamboo-cli autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

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

EXAMPLES
  $ bamboo-cli autocomplete
  $ bamboo-cli autocomplete bash
  $ bamboo-cli autocomplete zsh
  $ bamboo-cli autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

bamboo-cli build:latest [PLANKEY]

get latest build data

USAGE
  $ bamboo-cli build latest [PLANKEY]

ARGUMENTS
  PLANKEY  plan key

OPTIONS
  -j, --json

EXAMPLE
  $ bamboo-cli build latest --planKey <plan key>

See code: src\commands\build\latest.ts

bamboo-cli build:logs [PLANKEY] [BUILDNUMBER]

get plan logs

USAGE
  $ bamboo-cli build logs [PLANKEY] [BUILDNUMBER]

ARGUMENTS
  PLANKEY      plan key
  BUILDNUMBER  build number

OPTIONS
  -p, --poll

EXAMPLE
  $ bamboo-cli build logs <planKey> <buildNumber>

See code: src\commands\build\logs.ts

bamboo-cli build:results

get info on builds

USAGE
  $ bamboo-cli build results

OPTIONS
  -f, --failed
  -j, --json

EXAMPLE
  $ bamboo-cli build results

See code: src\commands\build\results.ts

bamboo-cli build:status [PLANKEY] [BUILDNUMBER]

get info on specific build

USAGE
  $ bamboo-cli build status [PLANKEY] [BUILDNUMBER]

ARGUMENTS
  PLANKEY      plan key
  BUILDNUMBER  build number

OPTIONS
  -j, --json
  -p, --poll

EXAMPLE
  $ bamboo-cli build status <projectKey> <buildNumber>

See code: src\commands\build\status.ts

bamboo-cli conf [KEY] [VALUE]

manage configuration

USAGE
  $ bamboo-cli conf [KEY] [VALUE]

ARGUMENTS
  KEY    key of the config
  VALUE  value of the config

OPTIONS
  -d, --cwd=cwd          config file location
  -d, --delete           delete?
  -h, --help             show CLI help
  -k, --key=key          key of the config
  -n, --name=name        config file name
  -p, --project=project  project name
  -v, --value=value      value of the config

See code: conf-cli

bamboo-cli currentuser

get the current user

USAGE
  $ bamboo-cli currentuser

EXAMPLE
  $ bamboo-cli currentuser
  {
     name: 'user@domain.com',
     fullName: 'John Smith',
     email: 'user@domain.com'
  }

See code: src\commands\currentuser.ts

bamboo-cli deploy:start

deploy a build

USAGE
  $ bamboo-cli deploy start

OPTIONS
  -e, --env=env          (required) environment ID
  -v, --version=version  (required) build version ID

EXAMPLE
  $ bamboo-cli deploy start -e 123 -v 456

See code: src\commands\deploy\start.ts

bamboo-cli deploy:status [DEPLOYID]

get info on specific deploy

USAGE
  $ bamboo-cli deploy status [DEPLOYID]

ARGUMENTS
  DEPLOYID  plan key

OPTIONS
  -j, --json
  -p, --poll

EXAMPLE
  $ bamboo-cli deploy status <deployId>

See code: src\commands\deploy\status.ts

bamboo-cli help [COMMAND]

display help for bamboo-cli

USAGE
  $ bamboo-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

bamboo-cli plans

get all plans

USAGE
  $ bamboo-cli plans

OPTIONS
  -e, --enabled
  -j, --json

EXAMPLES
  $ bamboo-cli plans
  $ bamboo-cli plans --enabled

See code: src\commands\plans.ts

bamboo-cli projects

get all projects

USAGE
  $ bamboo-cli projects

OPTIONS
  -j, --json

EXAMPLE
  $ bamboo-cli projects

See code: src\commands\projects.ts

bamboo-cli queue [PLANKEY]

queue a build

USAGE
  $ bamboo-cli queue [PLANKEY]

ARGUMENTS
  PLANKEY  get plan key by running "bamboo-cli plans".

OPTIONS
  -j, --json
  -p, --poll

EXAMPLE
  $ bamboo-cli queue <planKey>
  $ bamboo-cli queue <planKey> -p

See code: src\commands\queue.ts

bamboo-cli releases

gets releases available for a project

USAGE
  $ bamboo-cli releases

OPTIONS
  -p, --project=project  (required) project ID

EXAMPLE
  $ bamboo-cli releases --project <project-id>

See code: src\commands\releases.ts

bamboo-cli server

get server info

USAGE
  $ bamboo-cli server

EXAMPLE
  $ bamboo-cli server
  {
     version: 'x.x.x',
     edition: '',
     buildDate: 'yyyy-MM-dd...',
     buildNumber: 'xxx',
     state: 'RUNNING'
  }

See code: src\commands\server.ts

bamboo-cli autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ bamboo-cli autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

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

EXAMPLES
  $ bamboo-cli autocomplete
  $ bamboo-cli autocomplete bash
  $ bamboo-cli autocomplete zsh
  $ bamboo-cli autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

bamboo-cli build:logs [PLANKEY] [BUILDNUMBER]

get plan logs

USAGE
  $ bamboo-cli build logs [PLANKEY] [BUILDNUMBER]

ARGUMENTS
  PLANKEY      plan key
  BUILDNUMBER  build number

OPTIONS
  -p, --poll

EXAMPLE
  $ bamboo-cli build logs <planKey> <buildNumber>

See code: src\commands\build\logs.ts

bamboo-cli build:results

get info on builds

USAGE
  $ bamboo-cli build results

OPTIONS
  -f, --failed
  -j, --json

EXAMPLE
  $ bamboo-cli build results

See code: src\commands\build\results.ts

bamboo-cli build:status [PLANKEY] [BUILDNUMBER]

get info on specific build

USAGE
  $ bamboo-cli build status [PLANKEY] [BUILDNUMBER]

ARGUMENTS
  PLANKEY      plan key
  BUILDNUMBER  build number

OPTIONS
  -j, --json
  -p, --poll

EXAMPLE
  $ bamboo-cli build status <projectKey> <buildNumber>

See code: src\commands\build\status.ts

bamboo-cli conf [KEY] [VALUE]

manage configuration

USAGE
  $ bamboo-cli conf [KEY] [VALUE]

ARGUMENTS
  KEY    key of the config
  VALUE  value of the config

OPTIONS
  -d, --cwd=cwd          config file location
  -d, --delete           delete?
  -h, --help             show CLI help
  -k, --key=key          key of the config
  -n, --name=name        config file name
  -p, --project=project  project name
  -v, --value=value      value of the config

See code: conf-cli

bamboo-cli currentuser

get the current user

USAGE
  $ bamboo-cli currentuser

EXAMPLE
  $ bamboo-cli currentuser
  {
     name: 'user@domain.com',
     fullName: 'John Smith',
     email: 'user@domain.com'
  }

See code: src\commands\currentuser.ts

bamboo-cli deploy:start

deploy a build

USAGE
  $ bamboo-cli deploy start

OPTIONS
  -e, --env=env          (required) environment ID
  -v, --version=version  (required) build version ID

EXAMPLE
  $ bamboo-cli deploy start -e 123 -v 456

See code: src\commands\deploy\start.ts

bamboo-cli deploy:status [PLANKEY] [DEPLOYNUMBER]

get info on specific deploy

USAGE
  $ bamboo-cli deploy status [PLANKEY] [DEPLOYNUMBER]

ARGUMENTS
  PLANKEY       plan key
  DEPLOYNUMBER  deploy number

OPTIONS
  -j, --json
  -p, --poll

EXAMPLE
  $ bamboo-cli deploy status <projectKey> <deployNumber>

See code: src\commands\deploy\status.ts

bamboo-cli help [COMMAND]

display help for bamboo-cli

USAGE
  $ bamboo-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

bamboo-cli plans

get all plans

USAGE
  $ bamboo-cli plans

OPTIONS
  -e, --enabled
  -j, --json

EXAMPLES
  $ bamboo-cli plans
  $ bamboo-cli plans --enabled

See code: src\commands\plans.ts

bamboo-cli projects

get all projects

USAGE
  $ bamboo-cli projects

OPTIONS
  -j, --json

EXAMPLE
  $ bamboo-cli projects

See code: src\commands\projects.ts

bamboo-cli queue [PLANKEY]

queue a build

USAGE
  $ bamboo-cli queue [PLANKEY]

ARGUMENTS
  PLANKEY  get plan key by running "bamboo-cli plans".

OPTIONS
  -j, --json
  -p, --poll

EXAMPLE
  $ bamboo-cli queue <planKey>
  $ bamboo-cli queue <planKey> -p

See code: src\commands\queue.ts

bamboo-cli releases

gets releases available for a project

USAGE
  $ bamboo-cli releases

OPTIONS
  -p, --project=project  (required) project ID

EXAMPLE
  $ bamboo-cli releases --project <project-id>

See code: src\commands\releases.ts

bamboo-cli server

get server info

USAGE
  $ bamboo-cli server

EXAMPLE
  $ bamboo-cli server
  {
     version: 'x.x.x',
     edition: '',
     buildDate: 'yyyy-MM-dd...',
     buildNumber: 'xxx',
     state: 'RUNNING'
  }

See code: src\commands\server.ts

About

command-line tool to interact with Atlassian Bamboo

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages