An open API service indexing awesome lists of open source software.

https://github.com/craftamap/bb

inoffical Bitbucket.org command line tool
https://github.com/craftamap/bb

atlassian atlassian-bitbucket bitbucket bitbucket-api bitbucket-cloud bitbucket-pipelines cli golang hacktoberfest

Last synced: 3 months ago
JSON representation

inoffical Bitbucket.org command line tool

Awesome Lists containing this project

README

          

# bb

![github versions](https://img.shields.io/github/v/release/craftamap/bb?style=flat-square) ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/craftamap/bb/build?style=flat-square) [![Go Report Card](https://goreportcard.com/badge/github.com/craftamap/bb?style=flat-square)](https://goreportcard.com/report/github.com/craftamap/bb)

![bb logo](.github/bb-logo.png)

---

`bb` is an inoffical bitbucket.org command line tool deeply inspired by the
official [GitHub CLI](https://github.com/cli/cli/). It brings pull requests,
downloads, and other bitbucket concepts to your terminal.

![screenshot showing ](.github/screenshot_create_pr.png)

## Installation

### General

Check out the [Releases](https://github.com/craftamap/bb/releases) page where you
can find the latest releases built for every environment. This includes
builds for macOS, Windows, Debian, and many more!

### macOS

```bash
brew tap craftamap/tap && brew install bb
```

### Arch / AUR

```bash
yay bbcli-git
```

### Using `go get`
Make sure you have a working Go environment. Follow the
[Go install instructions](https://golang.org/doc/install).

```bash
go get github.com/craftamap/bb
```

### Building from source
Make sure you have a working Go environment. Follow the
[Go install instructions](https://golang.org/doc/install).

```bash
git clone https://github.com/craftamap/bb.git
go build
```

## Set-Up

You need to authenticate with your credentials first.
You can either use a [Scoped API Token](https://support.atlassian.com/bitbucket-cloud/docs/api-tokens/)
or an [app password (deprecated)](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/)
for that. Make sure to grant read and write access to the features you want to use.
(**Recommended**:Repositories: Read/Write, Pull Requests: Read/Write,
Pipelines: Read/Write, Account: Email/Read, Workspace membership: Read/Write).

Run the following command to enter your username and password:

```bash
bb auth login
```

If using an Scoped API Token, use your email address as the username and the API
Token as the password. If using an app password, use your bitbucket username as
username and the app password as password.

Your credentials will be stored to `~/.config/bb/configuration.toml`.

## Usage

To see all available commands, use `bb` without any subcommand.
Many commands support the `--web`-flag to execute the action in the browser, or
open the browser after performing an specific action.

### Pull Requests

You can use `bb pr create` to create new pull requests.

![Create prs within seconds](.github/screencast_pr_create.gif)

Also, you can use `bb pr` to list (`bb pr list`), view (`bb pr view`)
or merge existing pull requests (`bb pr merge`) and see how their pipelines
ran (`bb pr statuses`). Use `bb pr comments` to see the discussion of a pull
request. Use `bb pr checkout` to checkout the branch of a pull request.

![Manage prs like a ruler](.github/screencast_pr_flow.gif)

### Downloads

Manage downloads by listing (`bb downloads list`), downloading
(`bb downloads `) or uploading (`br downloads upload`) them.

![up and down](.github/screencast_downloads_flow.gif)

### Pipelines

Check the latest pipeline executions by running `bb pipelines list`. Find out
more about them by running `bb pipelines view `, or view their
logs by running `bb pipelines logs `.

![never gonna give you up](.github/screencast_pipelines_flow.gif)

### Repositories

View basic repository information by running `bb repo view`, or open the
repository in the browser by using `bb repo view --web`.

![A repo in all its beauty](.github/screencast_repo_view.gif)

### Issues

If you have the native bitbucket issues enabled in your project, you can list
all open issues by typing `bb issue list`. You can also create new ones using
`bb issue create`, update existing ones using `bb issue update `, delete
and view existing ones with `bb issue delete ` and `bb issue view ` and
comment them using `bb issue comment `.

## Development
### Used Libraries

We use the following bitbucket libary:

- https://github.com/ktrysmt/go-bitbucket (Apache-2.0 License)

Thanks a lot for the work!