@pilatos/bitbucket-cli 1.14.0 → 1.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +53 -8
- package/dist/index.js +766 -139
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -47,15 +47,28 @@
|
|
|
47
47
|
|
|
48
48
|
## Install
|
|
49
49
|
|
|
50
|
-
|
|
51
|
-
npm install -g @pilatos/bitbucket-cli
|
|
52
|
-
```
|
|
50
|
+
> **Requires:** [Bun](https://bun.sh) runtime 1.0 or higher. The CLI is installed via npm but runs on the Bun runtime — Node.js is not supported.
|
|
53
51
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
```
|
|
52
|
+
1. **Install Bun** (if `bun --version` fails):
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
curl -fsSL https://bun.sh/install | bash
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
2. **Install the CLI:**
|
|
57
59
|
|
|
58
|
-
|
|
60
|
+
```bash
|
|
61
|
+
npm install -g @pilatos/bitbucket-cli
|
|
62
|
+
bb --version
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
3. **Tab completion** (optional, recommended):
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
bb completion install
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Then restart your shell.
|
|
59
72
|
|
|
60
73
|
---
|
|
61
74
|
|
|
@@ -75,10 +88,26 @@ bb pr list
|
|
|
75
88
|
bb repo list
|
|
76
89
|
bb pr create --title "Add feature"
|
|
77
90
|
bb pr approve 42
|
|
91
|
+
bb browse 42 # open PR #42 in your browser
|
|
92
|
+
bb browse src/cli.ts:20 # open a file at a specific line
|
|
78
93
|
bb config set defaultWorkspace myworkspace
|
|
79
94
|
```
|
|
80
95
|
|
|
81
|
-
**Global options:** `--json`, `--no-color`, `-w, --workspace`, `-r, --repo`
|
|
96
|
+
**Global options:** `--json [fields]`, `--jq <expression>`, `--no-color`, `-w, --workspace`, `-r, --repo`
|
|
97
|
+
|
|
98
|
+
### Scripting with `--json` and `--jq`
|
|
99
|
+
|
|
100
|
+
`--json` accepts an optional comma-separated field list to project the output, and `--jq` filters the JSON in-process (no external `jq` binary required):
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
# Project to specific fields
|
|
104
|
+
bb pr list --json id,title,state
|
|
105
|
+
|
|
106
|
+
# Filter through built-in jq
|
|
107
|
+
bb pr list --json --jq '.pullRequests[] | select(.state == "OPEN") | .title'
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
See [JSON Output](https://bitbucket-cli.paulvanderlei.com/reference/json-output/) and the [Scripting guide](https://bitbucket-cli.paulvanderlei.com/guides/scripting/) for more.
|
|
82
111
|
|
|
83
112
|
---
|
|
84
113
|
|
|
@@ -89,6 +118,8 @@ Full documentation: **[bitbucket-cli.paulvanderlei.com](https://bitbucket-cli.pa
|
|
|
89
118
|
- [Quick Start Guide](https://bitbucket-cli.paulvanderlei.com/getting-started/quickstart/)
|
|
90
119
|
- [Command Reference](https://bitbucket-cli.paulvanderlei.com/commands/auth/)
|
|
91
120
|
- [Guides](https://bitbucket-cli.paulvanderlei.com/guides/scripting/) (Scripting, CI/CD)
|
|
121
|
+
- AI assistant integration (Claude Code, Cursor, Windsurf): see [Guides > AI Agents](https://bitbucket-cli.paulvanderlei.com/guides/ai-agents/)
|
|
122
|
+
- [Changelog](https://bitbucket-cli.paulvanderlei.com/help/changelog/) — what's new in recent releases
|
|
92
123
|
- [Help](https://bitbucket-cli.paulvanderlei.com/help/troubleshooting/) (Troubleshooting, FAQ)
|
|
93
124
|
|
|
94
125
|
---
|
|
@@ -102,6 +133,20 @@ Full documentation: **[bitbucket-cli.paulvanderlei.com](https://bitbucket-cli.pa
|
|
|
102
133
|
|
|
103
134
|
---
|
|
104
135
|
|
|
136
|
+
## Environment Variables
|
|
137
|
+
|
|
138
|
+
| Variable | Description |
|
|
139
|
+
| -------------- | ---------------------------------------------------------- |
|
|
140
|
+
| `BB_USERNAME` | Bitbucket username (fallback for `bb auth login`) |
|
|
141
|
+
| `BB_API_TOKEN` | Bitbucket API token (fallback for `bb auth login`; for CI) |
|
|
142
|
+
| `DEBUG` | Enable HTTP debug logging when set to `true` |
|
|
143
|
+
| `NO_COLOR` | Disable color output when set |
|
|
144
|
+
| `FORCE_COLOR` | Force color output when set (and not `0`) |
|
|
145
|
+
|
|
146
|
+
Full reference: [Environment variables](https://bitbucket-cli.paulvanderlei.com/reference/environment-variables/).
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
105
150
|
## Contributing
|
|
106
151
|
|
|
107
152
|
Read the [Contributing Guide](CONTRIBUTING.md) to get started.
|