bbk-acli
v0.1.3
Published
CLI for Bitbucket API interaction
Readme
bbk-acli
CLI for Bitbucket API interaction
Usage
$ npm install -g bbk-acli
$ bbk-acli COMMAND
running command...
$ bbk-acli (--version)
bbk-acli/0.1.3 linux-x64 node-v22.22.0
$ bbk-acli --help [COMMAND]
USAGE
$ bbk-acli COMMAND
...Commands
bbk-acli bb auth addbbk-acli bb auth testbbk-acli bb auth updatebbk-acli bb pipeline get WORKSPACE REPOSLUG PIPELINEUUIDbbk-acli bb pipeline list WORKSPACE REPOSLUGbbk-acli bb pipeline trigger WORKSPACE REPOSLUGbbk-acli bb pr approve WORKSPACE REPOSLUG PULLREQUESTIDbbk-acli bb pr create WORKSPACE REPOSLUGbbk-acli bb pr decline WORKSPACE REPOSLUG PULLREQUESTIDbbk-acli bb pr get WORKSPACE REPOSLUG PULLREQUESTIDbbk-acli bb pr list WORKSPACE REPOSLUGbbk-acli bb pr merge WORKSPACE REPOSLUG PULLREQUESTIDbbk-acli bb pr unapprove WORKSPACE REPOSLUG PULLREQUESTIDbbk-acli bb pr update WORKSPACE REPOSLUG PULLREQUESTIDbbk-acli bb repo create WORKSPACE REPOSLUGbbk-acli bb repo delete WORKSPACE REPOSLUGbbk-acli bb repo get WORKSPACE REPOSLUGbbk-acli bb repo list WORKSPACEbbk-acli bb workspace get WORKSPACEbbk-acli bb workspace listbbk-acli commandsbbk-acli help [COMMAND]bbk-acli update [CHANNEL]bbk-acli version
bbk-acli bb auth add
Add Atlassian authentication
USAGE
$ bbk-acli bb auth add -e <value> -t <value> [--json]
FLAGS
-e, --email=<value> (required) Account email:
-t, --token=<value> (required) API Token:
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Add Atlassian authentication
EXAMPLES
$ bbk-acli bb auth addSee code: src/commands/bb/auth/add.ts
bbk-acli bb auth test
Test authentication and connection
USAGE
$ bbk-acli bb auth test [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Test authentication and connection
EXAMPLES
$ bbk-acli bb auth testSee code: src/commands/bb/auth/test.ts
bbk-acli bb auth update
Update existing authentication
USAGE
$ bbk-acli bb auth update -e <value> -t <value> [--json]
FLAGS
-e, --email=<value> (required) Account email
-t, --token=<value> (required) API Token
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Update existing authentication
EXAMPLES
$ bbk-acli bb auth updateSee code: src/commands/bb/auth/update.ts
bbk-acli bb pipeline get WORKSPACE REPOSLUG PIPELINEUUID
Get details of a specific pipeline
USAGE
$ bbk-acli bb pipeline get WORKSPACE REPOSLUG PIPELINEUUID [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PIPELINEUUID Pipeline UUID
FLAGS
--toon Format output as toon
DESCRIPTION
Get details of a specific pipeline
EXAMPLES
$ bbk-acli bb pipeline get my-workspace my-repo {uuid}See code: src/commands/bb/pipeline/get.ts
bbk-acli bb pipeline list WORKSPACE REPOSLUG
List pipelines for a repository
USAGE
$ bbk-acli bb pipeline list WORKSPACE REPOSLUG [--page <value>] [--pagelen <value>] [--sort <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
FLAGS
--page=<value> [default: 1] Page number
--pagelen=<value> [default: 10] Number of items per page
--sort=<value> Sort field (e.g., created_on)
--toon Format output as toon
DESCRIPTION
List pipelines for a repository
EXAMPLES
$ bbk-acli bb pipeline list my-workspace my-repoSee code: src/commands/bb/pipeline/list.ts
bbk-acli bb pipeline trigger WORKSPACE REPOSLUG
Trigger a pipeline run
USAGE
$ bbk-acli bb pipeline trigger WORKSPACE REPOSLUG --branch <value> [--custom <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
FLAGS
--branch=<value> (required) Branch name to run pipeline on
--custom=<value> Custom pipeline pattern name
--toon Format output as toon
DESCRIPTION
Trigger a pipeline run
EXAMPLES
$ bbk-acli bb pipeline trigger my-workspace my-repo --branch main
$ bbk-acli bb pipeline trigger my-workspace my-repo --branch main --custom my-pipelineSee code: src/commands/bb/pipeline/trigger.ts
bbk-acli bb pr approve WORKSPACE REPOSLUG PULLREQUESTID
Approve a pull request
USAGE
$ bbk-acli bb pr approve WORKSPACE REPOSLUG PULLREQUESTID [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PULLREQUESTID Pull request ID
FLAGS
--toon Format output as toon
DESCRIPTION
Approve a pull request
EXAMPLES
$ bbk-acli bb pr approve my-workspace my-repo 123See code: src/commands/bb/pr/approve.ts
bbk-acli bb pr create WORKSPACE REPOSLUG
Create a new pull request
USAGE
$ bbk-acli bb pr create WORKSPACE REPOSLUG --destination <value> --source <value> --title <value> [--description
<value>] [--reviewers <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
FLAGS
--description=<value> Pull request description
--destination=<value> (required) Destination branch name
--reviewers=<value> Comma-separated list of reviewer UUIDs
--source=<value> (required) Source branch name
--title=<value> (required) Pull request title
--toon Format output as toon
DESCRIPTION
Create a new pull request
EXAMPLES
$ bbk-acli bb pr create my-workspace my-repo --title "My PR" --source feature-branch --destination mainSee code: src/commands/bb/pr/create.ts
bbk-acli bb pr decline WORKSPACE REPOSLUG PULLREQUESTID
Decline a pull request
USAGE
$ bbk-acli bb pr decline WORKSPACE REPOSLUG PULLREQUESTID [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PULLREQUESTID Pull request ID
FLAGS
--toon Format output as toon
DESCRIPTION
Decline a pull request
EXAMPLES
$ bbk-acli bb pr decline my-workspace my-repo 123See code: src/commands/bb/pr/decline.ts
bbk-acli bb pr get WORKSPACE REPOSLUG PULLREQUESTID
Get details of a specific pull request
USAGE
$ bbk-acli bb pr get WORKSPACE REPOSLUG PULLREQUESTID [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PULLREQUESTID Pull request ID
FLAGS
--toon Format output as toon
DESCRIPTION
Get details of a specific pull request
EXAMPLES
$ bbk-acli bb pr get my-workspace my-repo 123See code: src/commands/bb/pr/get.ts
bbk-acli bb pr list WORKSPACE REPOSLUG
List pull requests for a repository
USAGE
$ bbk-acli bb pr list WORKSPACE REPOSLUG [--page <value>] [--pagelen <value>] [--state <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
FLAGS
--page=<value> [default: 1] Page number
--pagelen=<value> [default: 10] Number of items per page
--state=<value> Filter by state (OPEN, MERGED, DECLINED, SUPERSEDED)
--toon Format output as toon
DESCRIPTION
List pull requests for a repository
EXAMPLES
$ bbk-acli bb pr list my-workspace my-repoSee code: src/commands/bb/pr/list.ts
bbk-acli bb pr merge WORKSPACE REPOSLUG PULLREQUESTID
Merge a pull request
USAGE
$ bbk-acli bb pr merge WORKSPACE REPOSLUG PULLREQUESTID [--close-source-branch] [-m <value>] [--strategy
merge_commit|squash|fast_forward] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PULLREQUESTID Pull request ID
FLAGS
-m, --message=<value> Merge commit message
--close-source-branch Close source branch after merge
--strategy=<option> Merge strategy (merge_commit, squash, fast_forward)
<options: merge_commit|squash|fast_forward>
--toon Format output as toon
DESCRIPTION
Merge a pull request
EXAMPLES
$ bbk-acli bb pr merge my-workspace my-repo 123See code: src/commands/bb/pr/merge.ts
bbk-acli bb pr unapprove WORKSPACE REPOSLUG PULLREQUESTID
Remove approval from a pull request
USAGE
$ bbk-acli bb pr unapprove WORKSPACE REPOSLUG PULLREQUESTID [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PULLREQUESTID Pull request ID
FLAGS
--toon Format output as toon
DESCRIPTION
Remove approval from a pull request
EXAMPLES
$ bbk-acli bb pr unapprove my-workspace my-repo 123See code: src/commands/bb/pr/unapprove.ts
bbk-acli bb pr update WORKSPACE REPOSLUG PULLREQUESTID
Update a pull request
USAGE
$ bbk-acli bb pr update WORKSPACE REPOSLUG PULLREQUESTID [--description <value>] [--title <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PULLREQUESTID Pull request ID
FLAGS
--description=<value> Pull request description
--title=<value> Pull request title
--toon Format output as toon
DESCRIPTION
Update a pull request
EXAMPLES
$ bbk-acli bb pr update my-workspace my-repo 1 --title "Updated title"See code: src/commands/bb/pr/update.ts
bbk-acli bb repo create WORKSPACE REPOSLUG
Create a new repository
USAGE
$ bbk-acli bb repo create WORKSPACE REPOSLUG [--description <value>] [--language <value>] [--private]
[--project-key <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
FLAGS
--description=<value> Repository description
--language=<value> Repository language
--private Make repository private
--project-key=<value> Project key
--toon Format output as toon
DESCRIPTION
Create a new repository
EXAMPLES
$ bbk-acli bb repo create my-workspace my-repo
$ bbk-acli bb repo create my-workspace my-repo --private --description "My new repo"See code: src/commands/bb/repo/create.ts
bbk-acli bb repo delete WORKSPACE REPOSLUG
Delete a repository
USAGE
$ bbk-acli bb repo delete WORKSPACE REPOSLUG [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
FLAGS
--toon Format output as toon
DESCRIPTION
Delete a repository
EXAMPLES
$ bbk-acli bb repo delete my-workspace my-repoSee code: src/commands/bb/repo/delete.ts
bbk-acli bb repo get WORKSPACE REPOSLUG
Get details of a specific repository
USAGE
$ bbk-acli bb repo get WORKSPACE REPOSLUG [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
FLAGS
--toon Format output as toon
DESCRIPTION
Get details of a specific repository
EXAMPLES
$ bbk-acli bb repo get my-workspace my-repoSee code: src/commands/bb/repo/get.ts
bbk-acli bb repo list WORKSPACE
List repositories in a workspace
USAGE
$ bbk-acli bb repo list WORKSPACE [--page <value>] [--pagelen <value>] [--q <value>] [--role <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
FLAGS
--page=<value> [default: 1] Page number
--pagelen=<value> [default: 10] Number of items per page
--q=<value> Query string to filter repositories
--role=<value> Filter by role (admin, contributor, member, owner)
--toon Format output as toon
DESCRIPTION
List repositories in a workspace
EXAMPLES
$ bbk-acli bb repo list my-workspaceSee code: src/commands/bb/repo/list.ts
bbk-acli bb workspace get WORKSPACE
Get details of a specific workspace
USAGE
$ bbk-acli bb workspace get WORKSPACE [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
FLAGS
--toon Format output as toon
DESCRIPTION
Get details of a specific workspace
EXAMPLES
$ bbk-acli bb workspace get my-workspaceSee code: src/commands/bb/workspace/get.ts
bbk-acli bb workspace list
List all accessible workspaces
USAGE
$ bbk-acli bb workspace list [--page <value>] [--pagelen <value>] [--toon]
FLAGS
--page=<value> [default: 1] Page number
--pagelen=<value> [default: 10] Number of items per page
--toon Format output as toon
DESCRIPTION
List all accessible workspaces
EXAMPLES
$ bbk-acli bb workspace listSee code: src/commands/bb/workspace/list.ts
bbk-acli commands
List all bbk-acli commands.
USAGE
$ bbk-acli commands [--json] [-c id|plugin|summary|type... | --tree] [--deprecated] [-x | ] [--hidden]
[--no-truncate | ] [--sort id|plugin|summary|type | ]
FLAGS
-c, --columns=<option>... Only show provided columns (comma-separated).
<options: id|plugin|summary|type>
-x, --extended Show extra columns.
--deprecated Show deprecated commands.
--hidden Show hidden commands.
--no-truncate Do not truncate output.
--sort=<option> [default: id] Property to sort by.
<options: id|plugin|summary|type>
--tree Show tree of commands.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List all bbk-acli commands.See code: @oclif/plugin-commands
bbk-acli help [COMMAND]
Display help for bbk-acli.
USAGE
$ bbk-acli 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 bbk-acli.See code: @oclif/plugin-help
bbk-acli update [CHANNEL]
update the bbk-acli CLI
USAGE
$ bbk-acli update [CHANNEL] [--force | | [-a | -v <value> | -i]] [-b ]
FLAGS
-a, --available See available versions.
-b, --verbose Show more details about the available versions.
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
-v, --version=<value> Install a specific version.
--force Force a re-download of the requested version.
DESCRIPTION
update the bbk-acli CLI
EXAMPLES
Update to the stable channel:
$ bbk-acli update stable
Update to a specific version:
$ bbk-acli update --version 1.0.0
Interactively select version:
$ bbk-acli update --interactive
See available versions:
$ bbk-acli update --availableSee code: @oclif/plugin-update
bbk-acli version
USAGE
$ bbk-acli version [--json] [--verbose]
FLAGS
--verbose Show additional information about the CLI.
GLOBAL FLAGS
--json Format output as json.
FLAG DESCRIPTIONS
--verbose Show additional information about the CLI.
Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.See code: @oclif/plugin-version
