Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swisscom/bitbucket-cli
A Bitbucket Enterprise CLI
https://github.com/swisscom/bitbucket-cli
bitbucket cli enterprise git
Last synced: 2 months ago
JSON representation
A Bitbucket Enterprise CLI
- Host: GitHub
- URL: https://github.com/swisscom/bitbucket-cli
- Owner: swisscom
- License: mit
- Created: 2021-06-01T07:24:08.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-04-07T11:39:01.000Z (almost 2 years ago)
- Last Synced: 2024-06-11T19:52:34.320Z (8 months ago)
- Topics: bitbucket, cli, enterprise, git
- Language: Go
- Homepage:
- Size: 67.4 KB
- Stars: 15
- Watchers: 14
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bitbucket-cli
A [Bitbucket Enterprise](https://bitbucket.org/product/enterprise) CLI.
```
Usage: bitbucket-cli [--username USERNAME] [--password PASSWORD] --url URL []
Options:
--username USERNAME, -u USERNAME
--password PASSWORD, -p PASSWORD
--url URL, -u URL
--help, -h display this help and exit
Commands:
project
```
# Docker container
A docker container for this project can be obtained [here](https://github.com/swisscom/bitbucket-cli/pkgs/container/bitbucket-cli).
## Project
### List
Lists the repositories in a project
```
$ export BITBUCKET_USERNAME="my-bitbucket-username"
$ read -s BITBUCKET_PASSWORD # Type your password and then press ENTER
$ export BITBUCKET_PASSWORD
$ bitbucket-cli --url https://your-bitbucket-hostname/rest project list -k PRJKEY
project-1 https://your-bitbucket-hostname/scm/prjkey/project-1.git
project-2 https://your-bitbucket-hostname/scm/prjkey/project-2.git
project-3 https://your-bitbucket-hostname/scm/prjkey/project-3.git
```
### Clone
Clones all the repositories in a project:
```
$ export BITBUCKET_USERNAME="my-bitbucket-username"
$ read -r -s BITBUCKET_PASSWORD # Type your password and then press ENTER
$ export BITBUCKET_PASSWORD
$ bitbucket-cli --url https://your-bitbucket-hostname/rest project clone -k PRJKEY -o /tmp/test/
head: 987a5d8c25d8adb5ba013cf1cb88cd56a189241e5048b9702f319fb6e641cf81 refs/heads/master
head: df2b794192904e6a9265975f33510eebe680177013e86fd7002850f45389ad34 refs/heads/master
head: 2cf20bee2c59c3b8cae6ec0820a1353ff0ca2adeecdb84ba773845cff91ab121 refs/heads/master
$ ls -la /tmp/test
total 0
drwxr-xr-x 13 dvitali dvitali 260 Jul 21 18:09 .
drwxrwxrwt 29 root root 1400 Jul 21 18:11 ..
drwxr-xr-x 3 dvitali dvitali 120 Jul 21 18:09 project-1
drwxr-xr-x 4 dvitali dvitali 140 Jul 21 18:09 project-2
drwxr-xr-x 3 dvitali dvitali 100 Jul 21 18:09 project-3
```
## Repo
This main subcommand requires two arguments:
- `-k KEY`
- `-n NAME`
These are basically the identifiers for your repository, not including one of the twos in all of the
subcommands will result in an error.
### PR
This subcommand deals with PRs, please check its subcommands.
#### Create
This command, subcommand of (`repo pr`) allows you to create a Pull Request.
Use it as follows:
```
bitbucket-cli repo -k "KEY" \
-n "bitbucket-playground" \
pr create \
-t "Some Title" \
-d "Some Description :thumbsup:" \
-F "refs/heads/feature/2" -T "refs/heads/master"
```
##### Usage
```
Usage: bitbucket-cli repo pr create --title TITLE [--description DESCRIPTION] --from-ref FROM-REF --to-ref TO-REF [--from-key FROM-KEY] [--from-slug FROM-SLUG]
Options:
--title TITLE, -t TITLE
Title of this PR
--description DESCRIPTION, -d DESCRIPTION
Description of the PR
--from-ref FROM-REF, -F FROM-REF
Reference of the incoming PR, e.g: refs/heads/feature-ABC-123
--to-ref TO-REF, -T TO-REF
Target reference, e.g: refs/heads/master
--from-key FROM-KEY, -K FROM-KEY
Project Key of the "from" repository
--from-slug FROM-SLUG, -S FROM-SLUG
Repository slug of the "from" repository
--help, -h display this help and exit
```
#### List
Lists all the PRs for the chosen repository
```
$ bitbucket-cli repo -k KEY -n bitbucket-playground pr list
Some Title (ID: 2)
feature 1 (ID: 1)
```
```
$ bitbucket-cli repo -k KEY -n bitbucket-playground pr list -s DECLINED
feature 1 (ID: 1)
```
##### Usage
```plain
Usage: bitbucket-cli repo pr list [--state STATE]
Options:
--state STATE, -s STATE
PR State, any of: ALL, OPEN, DECLINED, MERGED
--help, -h display this help and exit
```
### Security
#### Scan
##### Usage
```plain
Usage: bitbucket-cli repo security scan
Options:
--help, -h display this help and exit
```
##### Example
```plain
bitbucket-cli repo -k ABC -n some-repo security scan
```