@hesed/bb
v0.10.1
Published
CLI for Bitbucket API interaction
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.10.1 linux-x64 node-v24.18.0
$ bb --help [COMMAND]
USAGE
$ bb COMMAND
...Commands
bb bb auth addbb bb auth deletebb bb auth listbb bb auth profilebb bb auth testbb bb auth updatebb bb commit WORKSPACE REPOSLUG COMMITSHAbb bb commit list WORKSPACE REPOSLUGbb bb pipeline WORKSPACE REPOSLUGbb bb pipeline get WORKSPACE REPOSLUG PIPELINEUUIDbb bb pipeline trigger WORKSPACE REPOSLUGbb bb pr WORKSPACE REPOSLUG PULLREQUESTIDbb bb pr activity WORKSPACE REPOSLUG PRIDbb bb pr approve WORKSPACE REPOSLUG PULLREQUESTIDbb bb pr comment WORKSPACE REPOSLUG PRIDbb bb pr comment-delete WORKSPACE REPOSLUG PRID COMMENTIDbb bb pr comment-reply WORKSPACE REPOSLUG PRID COMMENTIDbb bb pr comment-resolve WORKSPACE REPOSLUG PRID COMMENTIDbb bb pr comment-update WORKSPACE REPOSLUG PRID COMMENTIDbb bb pr comments WORKSPACE REPOSLUG PRIDbb bb pr commits WORKSPACE REPOSLUG PRIDbb bb pr create WORKSPACE REPOSLUGbb bb pr decline WORKSPACE REPOSLUG PULLREQUESTIDbb bb pr diff 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 WORKSPACE REPOSLUGbb bb repo create WORKSPACE REPOSLUGbb bb repo delete WORKSPACE REPOSLUGbb bb repo list WORKSPACEbb bb workspace WORKSPACEbb bb workspace list
bb bb auth add
Add Bitbucket authentication
USAGE
$ bb bb auth add -p <value> -t <value> -e <value> -u <value> [--json]
FLAGS
-e, --email=<value> (required) Account email
-p, --profile=<value> (required) Profile name
-t, --apiToken=<value> (required) API Token
-u, --host=<value> (required) Bitbucket instance URL
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Add Bitbucket authentication
EXAMPLES
$ bb bb auth add
$ bb bb auth add -p prodSee code: src/commands/bb/auth/add.ts
bb bb auth delete
Delete an authentication profile
USAGE
$ bb bb auth delete [--json] [-p <value>]
FLAGS
-p, --profile=<value> Profile to delete
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Delete an authentication profile
EXAMPLES
$ bb bb auth delete
$ bb bb auth delete -p prodSee code: src/commands/bb/auth/delete.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 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 testSee 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 -p prodSee code: src/commands/bb/auth/test.ts
bb bb auth update
Update Bitbucket authentication
USAGE
$ bb bb auth update -p <value> -t <value> -e <value> -u <value> [--json]
FLAGS
-e, --email=<value> (required) Account email
-p, --profile=<value> (required) Profile name
-t, --apiToken=<value> (required) API Token
-u, --host=<value> (required) Bitbucket instance URL
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Update Bitbucket authentication
EXAMPLES
$ bb bb auth update
$ bb bb auth update -p testSee code: src/commands/bb/auth/update.ts
bb bb commit WORKSPACE REPOSLUG COMMITSHA
Get details of a specific commit
USAGE
$ bb bb commit WORKSPACE REPOSLUG COMMITSHA [-p <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
COMMITSHA Commit SHA
FLAGS
-p, --profile=<value> Authentication profile name
--toon Format output as toon
DESCRIPTION
Get details of a specific commit
EXAMPLES
$ bb bb commit my-workspace my-repo a1b2c3dSee code: src/commands/bb/commit/index.ts
bb bb commit list WORKSPACE REPOSLUG
List commits for a repository, optionally restricted to a range
USAGE
$ bb bb commit list WORKSPACE REPOSLUG [--exclude <value>...] [--include <value>...] [--page <value>] [--pagelen
<value>] [-p <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
FLAGS
-p, --profile=<value> Authentication profile name
--exclude=<value>... Exclude commits reachable from this SHA or branch (repeatable)
--include=<value>... Include commits reachable from this SHA or branch (repeatable)
--page=<value> [default: 1] Page number
--pagelen=<value> [default: 10] Number of items per page
--toon Format output as toon
DESCRIPTION
List commits for a repository, optionally restricted to a range
EXAMPLES
$ bb bb commit list my-workspace my-repo
$ bb bb commit list my-workspace my-repo --include feature-branch --exclude mainSee code: src/commands/bb/commit/list.ts
bb bb pipeline WORKSPACE REPOSLUG
List pipelines for a repository
USAGE
$ bb bb pipeline 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 my-workspace my-repoSee code: src/commands/bb/pipeline/index.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 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 WORKSPACE REPOSLUG PULLREQUESTID
Get details of a specific pull request
USAGE
$ bb bb pr 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 my-workspace my-repo 123See code: src/commands/bb/pr/index.ts
bb bb pr activity WORKSPACE REPOSLUG PRID
List activity events on a pull request
USAGE
$ bb bb pr activity WORKSPACE REPOSLUG PRID [--page <value>] [--pagelen <value>] [-p <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PRID Pull request ID
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 activity events on a pull request
EXAMPLES
$ bb bb pr activity my-workspace my-repo 42See code: src/commands/bb/pr/activity.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 comment WORKSPACE REPOSLUG PRID
Add a comment to a pull request, optionally on a specific file and line
USAGE
$ bb bb pr comment WORKSPACE REPOSLUG PRID --body <value> [--file <value>] [--line <value>] [-p <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PRID Pull request ID
FLAGS
-p, --profile=<value> Authentication profile name
--body=<value> (required) Comment text
--file=<value> File path for inline comment
--line=<value> Line number for inline comment
--toon Format output as toon
DESCRIPTION
Add a comment to a pull request, optionally on a specific file and line
EXAMPLES
$ bb bb pr comment my-workspace my-repo 42 --body "Looks good!"
$ bb bb pr comment my-workspace my-repo 42 --body "Fix this" --file src/foo.ts --line 15See code: src/commands/bb/pr/comment.ts
bb bb pr comment-delete WORKSPACE REPOSLUG PRID COMMENTID
Delete a comment on a pull request
USAGE
$ bb bb pr comment-delete WORKSPACE REPOSLUG PRID COMMENTID [-p <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PRID Pull request ID
COMMENTID Comment ID to delete
FLAGS
-p, --profile=<value> Authentication profile name
--toon Format output as toon
DESCRIPTION
Delete a comment on a pull request
EXAMPLES
$ bb bb pr comment-delete my-workspace my-repo 42 100See code: src/commands/bb/pr/comment-delete.ts
bb bb pr comment-reply WORKSPACE REPOSLUG PRID COMMENTID
Reply to a comment on a pull request
USAGE
$ bb bb pr comment-reply WORKSPACE REPOSLUG PRID COMMENTID --body <value> [-p <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PRID Pull request ID
COMMENTID Comment ID to reply to
FLAGS
-p, --profile=<value> Authentication profile name
--body=<value> (required) Reply text
--toon Format output as toon
DESCRIPTION
Reply to a comment on a pull request
EXAMPLES
$ bb bb pr comment-reply my-workspace my-repo 42 100 --body "Thanks for the feedback!"See code: src/commands/bb/pr/comment-reply.ts
bb bb pr comment-resolve WORKSPACE REPOSLUG PRID COMMENTID
Resolve a comment on a pull request
USAGE
$ bb bb pr comment-resolve WORKSPACE REPOSLUG PRID COMMENTID [-p <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PRID Pull request ID
COMMENTID Comment ID to resolve
FLAGS
-p, --profile=<value> Authentication profile name
--toon Format output as toon
DESCRIPTION
Resolve a comment on a pull request
EXAMPLES
$ bb bb pr comment-resolve my-workspace my-repo 42 100See code: src/commands/bb/pr/comment-resolve.ts
bb bb pr comment-update WORKSPACE REPOSLUG PRID COMMENTID
Update a comment on a pull request
USAGE
$ bb bb pr comment-update WORKSPACE REPOSLUG PRID COMMENTID --body <value> [-p <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PRID Pull request ID
COMMENTID Comment ID to update
FLAGS
-p, --profile=<value> Authentication profile name
--body=<value> (required) New comment text
--toon Format output as toon
DESCRIPTION
Update a comment on a pull request
EXAMPLES
$ bb bb pr comment-update my-workspace my-repo 42 100 --body "Updated comment text"See code: src/commands/bb/pr/comment-update.ts
bb bb pr comments WORKSPACE REPOSLUG PRID
List comments on a pull request
USAGE
$ bb bb pr comments WORKSPACE REPOSLUG PRID [--page <value>] [--pagelen <value>] [-p <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PRID Pull request ID
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 comments on a pull request
EXAMPLES
$ bb bb pr comments my-workspace my-repo 42See code: src/commands/bb/pr/comments.ts
bb bb pr commits WORKSPACE REPOSLUG PRID
List commits on a pull request
USAGE
$ bb bb pr commits WORKSPACE REPOSLUG PRID [--page <value>] [--pagelen <value>] [-p <value>] [--toon]
ARGUMENTS
WORKSPACE Workspace slug or UUID
REPOSLUG Repository slug
PRID Pull request ID
FLAGS
-p, --profile=<value> Authentication profile name
--page=<value> Opaque page token from a previous response next link
--pagelen=<value> [default: 10] Number of items per page
--toon Format output as toon
DESCRIPTION
List commits on a pull request
EXAMPLES
$ bb bb pr commits my-workspace my-repo 42
$ bb bb pr commits my-workspace my-repo 42 --page 67FgSee code: src/commands/bb/pr/commits.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 list WORKSPACE REPOSLUG
List pull requests for a repository
USAGE
$ bb bb pr list WORKSPACE REPOSLUG [--page <value>] [--pagelen <value>] [-p <value>] [--q <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
--q=<value> Query string filter (e.g. created_on>="2026-04-01")
--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 WORKSPACE REPOSLUG
Get details of a specific repository
USAGE
$ bb bb repo 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 my-workspace my-repoSee code: src/commands/bb/repo/index.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 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 WORKSPACE
Get details of a specific workspace
USAGE
$ bb bb workspace 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 my-workspaceSee code: src/commands/bb/workspace/index.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
