BB

CLI For Bitbucket Cloud

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • Status
2. Usage
3. Development
   • Prerequisites
   • Installation
4. Roadmap
5. Contributing
6. License
7. Contact
8. References

About The Project

A Bitbucket Cloud compatible CLI that let's you interact with your Bitbucket resources without leaving your terminal.

🔝

Built With

🔝

Status

🔝

Development

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Testing and developing the application locally requires go1.22.7 to be available (the latest release to be tested for now).
See the official documentation for instructions on installing Go on your platform of choice.

macOS Example

brew install go
go version
# example output:
# go version go1.22.7 linux/amd64

Installation

1. Clone the repo

git clone https://github.com/suny-am/bitbucket-cli.git

2. Build

cd bb

2.b Local

cd bb && \
go build

2.a Docker

docker build . -t bb
docker run -id -v . bb:latest
docker exec -it <container-name> bash
go build

🔝

Usage

Currently, only READ actions (such as viewing repositories, pull requests and searching for code) is supported, but the plan is to integrate all actions supported by the official Bitbucket REST API.

Usage examples

Repositories

# List repositories
bb repo list

# List repositories in a workspace
bb repo list -w my-workspace

# List repsitories with a custom limit
bb repo list -l 500

# View a repository
bb repo view -w my-workspace my-repo

Pullrequests

# List pullrequests for a repository
bb pr list -w my-workspace -r my-repo

# View a specific pullrequest
bb pr view -w my-workspace -r my-repo my-pullrequest

Code Search

# Search for code in a workspace
bb code search -w my-workspace variableName

# Search for code in a repository
bb code search -w my-workspace -r my-repo variableName

# Multiple terms are supported
bb code search -w my-workspace -r my-repo "variable1 variable2 const1"

# As are non ASCII characters
bb code search -w my-workspace -r my-repo "myfunc() => { x % 5 == 0 }"

For more examples, please refer to the Documentation

🔝

Feature Roadmap

• Core commands
  • Root
  • Workspace
  • Repository
    • Branch restrictions
    • Branching model
    • Commits
    • Deploy Keys
    • Downloads
    • Environments
    • Repositories
    • Pullrequests
    • Refs
    • Reports
    • Source
  • Project
    • Branch restrictions
    • Branching model
    • Deploy Keys
    • Issue tracker
    • Pipelines
    • Projects
  • User
    • Pullrequests
  • Snippets
• Flags
• Help Topics
• Config
• Auth
• TBD

See the open issues for a full list of proposed features (and known issues).

🔝

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project

gh repo fork suny-am/bitbucket-cli --clone
cd bitbucket-cli

2. Create your Feature Branch

git checkout -b feature/aNewCoolFeature

3. Commit your Changes

`git commit -m 'Add a new cool feature'

4. Push to the Branch

git push origin feature/aNewCoolFeature

5. Open a Pull Request

gh pr create

🔝

License

Distributed under the MIT License. See LICENSE for more information.

🔝

Contact

Your Name - @bsky_handle - [email protected]

Project Link: https://github.com/suny-am/bb

🔝

References

• Atlassian Bitbucket Cloud REST API Documentation

🔝

🔝