@hesed/bb
v0.5.1
Published
CLI for Bitbucket API interaction
Downloads
379
Readme
bb
CLI for Bitbucket API interaction
Install
sdkck plugins install @hesed/bbUsage
$ npm install -g @hesed/bb
$ bb COMMAND
running command...
$ bb (--version)
@hesed/bb/0.5.1 linux-x64 node-v24.14.1
$ bb --help [COMMAND]
USAGE
$ bb COMMAND
...Commands
bb bb auth addbb bb auth listbb bb auth profilebb bb auth testbb bb auth updatebb bb pipeline get WORKSPACE REPOSLUG PIPELINEUUIDbb bb pipeline list WORKSPACE REPOSLUGbb bb pipeline trigger WORKSPACE REPOSLUGbb bb pr approve WORKSPACE REPOSLUG PULLREQUESTIDbb bb pr create WORKSPACE REPOSLUGbb bb pr decline WORKSPACE REPOSLUG PULLREQUESTIDbb bb pr diff WORKSPACE REPOSLUG PULLREQUESTIDbb bb pr get WORKSPACE REPOSLUG PULLREQUESTIDbb bb pr list WORKSPACE REPOSLUGbb bb pr merge WORKSPACE REPOSLUG PULLREQUESTIDbb bb pr unapprove WORKSPACE REPOSLUG PULLREQUESTIDbb bb pr update WORKSPACE REPOSLUG PULLREQUESTIDbb bb repo create WORKSPACE REPOSLUGbb bb repo delete WORKSPACE REPOSLUGbb bb repo get WORKSPACE REPOSLUGbb bb repo list WORKSPACEbb bb workspace get WORKSPACEbb bb workspace list
bb bb auth add
Add Bitbucket authentication
USAGE
$ bb bb auth add -t <value> [--json] [-e <value>] [-p <value>]
FLAGS
-e, --email=<value> Account email
-p, --profile=<value> Profile name
-t, --token=<value> (required) API Token
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Add Bitbucket authentication
EXAMPLES
$ bb bb auth add
$ bb bb auth add --profile workSee code: src/commands/bb/auth/add.ts
bb bb auth list
List authentication profiles
USAGE
$ bb bb auth list [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List authentication profiles
EXAMPLES
$ bb bb auth listSee code: src/commands/bb/auth/list.ts
bb bb auth profile
Set or show the default authentication profile
USAGE
$ bb bb auth profile [--json] [--default <value>]
FLAGS
--default=<value> Profile name to set as default
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Set or show the default authentication profile
EXAMPLES
$ bb bb auth profile
$ bb bb auth profile --default workSee code: src/commands/bb/auth/profile.ts
bb bb auth test
Test authentication and connection
USAGE
$ bb bb auth test [--json] [-p <value>]
FLAGS
-p, --profile=<value> Authentication profile name
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Test authentication and connection
EXAMPLES
$ bb bb auth test
$ bb bb auth test --profile workSee code: src/commands/bb/auth/test.ts
bb bb auth update
Update existing authentication profile
USAGE
$ bb bb auth update -t <value> [--json] [-e <value>] [-p <value>]
FLAGS
-e, --email=<value> Account email
-p, --profile=<value> Profile name to update (default: "default")
-t, --token=<value> (required) API Token
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Update existing authentication profile
EXAMPLES
$ bb bb auth update
$ bb bb auth update --profile workSee code: src/commands/bb/auth/update.ts
bb bb pipeline get WORKSPACE REPOSLUG PIPELINEUUID
Get details of a specific pipeline
USAGE
$ bb bb pipeline get WORKSPACE REPOSLUG PIPELINEUUID [-p <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PIPELINEUUID Pipeline UUID
FLAGS
-p, --profile=<value> Authentication profile name
--toon Format output as toon
DESCRIPTION
Get details of a specific pipeline
EXAMPLES
$ bb bb pipeline get my-workspace my-repo {uuid}See code: src/commands/bb/pipeline/get.ts
bb bb pipeline list WORKSPACE REPOSLUG
List pipelines for a repository
USAGE
$ bb bb pipeline list WORKSPACE REPOSLUG [--page <value>] [--pagelen <value>] [-p <value>] [--sort <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
FLAGS
-p, --profile=<value> Authentication profile name
--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
$ bb bb pipeline list my-workspace my-repoSee code: src/commands/bb/pipeline/list.ts
bb bb pipeline trigger WORKSPACE REPOSLUG
Trigger a pipeline run
USAGE
$ bb bb pipeline trigger WORKSPACE REPOSLUG --branch <value> [--custom <value>] [-p <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
FLAGS
-p, --profile=<value> Authentication profile name
--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
$ bb bb pipeline trigger my-workspace my-repo --branch main
$ bb bb pipeline trigger my-workspace my-repo --branch main --custom my-pipelineSee code: src/commands/bb/pipeline/trigger.ts
bb bb pr approve WORKSPACE REPOSLUG PULLREQUESTID
Approve a pull request
USAGE
$ bb bb pr approve WORKSPACE REPOSLUG PULLREQUESTID [-p <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PULLREQUESTID Pull request ID
FLAGS
-p, --profile=<value> Authentication profile name
--toon Format output as toon
DESCRIPTION
Approve a pull request
EXAMPLES
$ bb bb pr approve my-workspace my-repo 123See code: src/commands/bb/pr/approve.ts
bb bb pr create WORKSPACE REPOSLUG
Create a new pull request
USAGE
$ bb bb pr create WORKSPACE REPOSLUG --destination <value> --source <value> --title <value> [--description
<value>] [-p <value>] [--reviewers <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
FLAGS
-p, --profile=<value> Authentication profile name
--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
$ bb bb pr create my-workspace my-repo --title "My PR" --source feature-branch --destination mainSee code: src/commands/bb/pr/create.ts
bb bb pr decline WORKSPACE REPOSLUG PULLREQUESTID
Decline a pull request
USAGE
$ bb bb pr decline WORKSPACE REPOSLUG PULLREQUESTID [-p <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PULLREQUESTID Pull request ID
FLAGS
-p, --profile=<value> Authentication profile name
--toon Format output as toon
DESCRIPTION
Decline a pull request
EXAMPLES
$ bb bb pr decline my-workspace my-repo 123See code: src/commands/bb/pr/decline.ts
bb bb pr diff WORKSPACE REPOSLUG PULLREQUESTID
Get the diff for a pull request
USAGE
$ bb bb pr diff WORKSPACE REPOSLUG PULLREQUESTID [-p <value>]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PULLREQUESTID Pull request ID
FLAGS
-p, --profile=<value> Authentication profile name
DESCRIPTION
Get the diff for a pull request
EXAMPLES
$ bb bb pr diff my-workspace my-repo 123See code: src/commands/bb/pr/diff.ts
bb bb pr get WORKSPACE REPOSLUG PULLREQUESTID
Get details of a specific pull request
USAGE
$ bb bb pr get WORKSPACE REPOSLUG PULLREQUESTID [-p <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PULLREQUESTID Pull request ID
FLAGS
-p, --profile=<value> Authentication profile name
--toon Format output as toon
DESCRIPTION
Get details of a specific pull request
EXAMPLES
$ bb bb pr get my-workspace my-repo 123See code: src/commands/bb/pr/get.ts
bb bb pr list WORKSPACE REPOSLUG
List pull requests for a repository
USAGE
$ bb bb pr list WORKSPACE REPOSLUG [--page <value>] [--pagelen <value>] [-p <value>] [--state <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
FLAGS
-p, --profile=<value> Authentication profile name
--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
$ bb bb pr list my-workspace my-repoSee code: src/commands/bb/pr/list.ts
bb bb pr merge WORKSPACE REPOSLUG PULLREQUESTID
Merge a pull request
USAGE
$ bb bb pr merge WORKSPACE REPOSLUG PULLREQUESTID [--close-source-branch] [-m <value>] [-p <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
-p, --profile=<value> Authentication profile name
--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
$ bb bb pr merge my-workspace my-repo 123See code: src/commands/bb/pr/merge.ts
bb bb pr unapprove WORKSPACE REPOSLUG PULLREQUESTID
Remove approval from a pull request
USAGE
$ bb bb pr unapprove WORKSPACE REPOSLUG PULLREQUESTID [-p <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PULLREQUESTID Pull request ID
FLAGS
-p, --profile=<value> Authentication profile name
--toon Format output as toon
DESCRIPTION
Remove approval from a pull request
EXAMPLES
$ bb bb pr unapprove my-workspace my-repo 123See code: src/commands/bb/pr/unapprove.ts
bb bb pr update WORKSPACE REPOSLUG PULLREQUESTID
Update a pull request
USAGE
$ bb bb pr update WORKSPACE REPOSLUG PULLREQUESTID [--description <value>] [-p <value>] [--title <value>]
[--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PULLREQUESTID Pull request ID
FLAGS
-p, --profile=<value> Authentication profile name
--description=<value> Pull request description
--title=<value> Pull request title
--toon Format output as toon
DESCRIPTION
Update a pull request
EXAMPLES
$ bb bb pr update my-workspace my-repo 1 --title "Updated title"See code: src/commands/bb/pr/update.ts
bb bb repo create WORKSPACE REPOSLUG
Create a new repository
USAGE
$ bb bb repo create WORKSPACE REPOSLUG [--description <value>] [--language <value>] [--private] [-p <value>]
[--project-key <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
FLAGS
-p, --profile=<value> Authentication profile name
--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
$ bb bb repo create my-workspace my-repo
$ bb bb repo create my-workspace my-repo --private --description "My new repo"See code: src/commands/bb/repo/create.ts
bb bb repo delete WORKSPACE REPOSLUG
Delete a repository
USAGE
$ bb bb repo delete WORKSPACE REPOSLUG [-p <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
FLAGS
-p, --profile=<value> Authentication profile name
--toon Format output as toon
DESCRIPTION
Delete a repository
EXAMPLES
$ bb bb repo delete my-workspace my-repoSee code: src/commands/bb/repo/delete.ts
bb bb repo get WORKSPACE REPOSLUG
Get details of a specific repository
USAGE
$ bb bb repo get WORKSPACE REPOSLUG [-p <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
FLAGS
-p, --profile=<value> Authentication profile name
--toon Format output as toon
DESCRIPTION
Get details of a specific repository
EXAMPLES
$ bb bb repo get my-workspace my-repoSee code: src/commands/bb/repo/get.ts
bb bb repo list WORKSPACE
List repositories in a workspace
USAGE
$ bb bb repo list WORKSPACE [--page <value>] [--pagelen <value>] [-p <value>] [--q <value>] [--role <value>]
[--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
FLAGS
-p, --profile=<value> Authentication profile name
--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
$ bb bb repo list my-workspaceSee code: src/commands/bb/repo/list.ts
bb bb workspace get WORKSPACE
Get details of a specific workspace
USAGE
$ bb bb workspace get WORKSPACE [-p <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
FLAGS
-p, --profile=<value> Authentication profile name
--toon Format output as toon
DESCRIPTION
Get details of a specific workspace
EXAMPLES
$ bb bb workspace get my-workspaceSee code: src/commands/bb/workspace/get.ts
bb bb workspace list
List all accessible workspaces
USAGE
$ bb bb workspace list [--page <value>] [--pagelen <value>] [-p <value>] [--toon]
FLAGS
-p, --profile=<value> Authentication profile name
--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
$ bb bb workspace listSee code: src/commands/bb/workspace/list.ts
