bitrise-api-cli 0.0.11 → 0.1.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 +37 -35
- package/dist/cli.js +3652 -10
- package/package.json +50 -14
- package/dist/chunk-CF25N4TY.js +0 -6
- package/dist/impl-KCO2VZ2R.js +0 -1696
package/README.md
CHANGED
|
@@ -1,34 +1,47 @@
|
|
|
1
|
-
#
|
|
1
|
+
# bitrise-api-cli [![npm][npm-image]][npm-url] ![npm][npm-dl-stats]
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Download the latest Bitrise build artifact for a workflow without clicking through the UI.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
`bitrise-api-cli` is an unofficial Bitrise CLI focused on one job: find the latest successful build for a workflow, pick the matching artifact, and download it locally.
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
- Workflow-based retrieval
|
|
9
|
-
- CI/CD integration
|
|
7
|
+
## Quick Start
|
|
10
8
|
|
|
11
|
-
|
|
9
|
+
```bash
|
|
10
|
+
npx bitrise-api-cli@latest download \
|
|
11
|
+
--token <BITRISE_TOKEN> \
|
|
12
|
+
--workflow <WORKFLOW_NAME> \
|
|
13
|
+
--slug <APP_SLUG>
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## What It Can Download
|
|
12
17
|
|
|
13
|
-
|
|
18
|
+
- `android-apk` artifacts (default)
|
|
19
|
+
- `ios-ipa` artifacts
|
|
20
|
+
|
|
21
|
+
For Android artifacts you can also install the downloaded file immediately:
|
|
14
22
|
|
|
15
23
|
```bash
|
|
16
|
-
npx bitrise-api-cli@latest download
|
|
24
|
+
npx bitrise-api-cli@latest download \
|
|
25
|
+
--artifact android-apk \
|
|
26
|
+
--install \
|
|
27
|
+
--token <BITRISE_TOKEN> \
|
|
28
|
+
--workflow android-release \
|
|
29
|
+
--slug <APP_SLUG>
|
|
17
30
|
```
|
|
18
31
|
|
|
19
|
-
##
|
|
32
|
+
## Configuration
|
|
20
33
|
|
|
21
|
-
You can combine command
|
|
34
|
+
You can combine command flags, environment variables, and `.bitrise.json`.
|
|
22
35
|
|
|
23
36
|
### Environment Variables
|
|
24
37
|
|
|
25
38
|
- `BITRISE_API_CLI_TOKEN`
|
|
26
39
|
- `BITRISE_API_CLI_WORKFLOW`
|
|
27
|
-
- `BITRISE_APP_SLUG`
|
|
40
|
+
- `BITRISE_APP_SLUG`
|
|
28
41
|
|
|
29
|
-
|
|
42
|
+
`BITRISE_APP_SLUG` is usually available automatically in Bitrise CI.
|
|
30
43
|
|
|
31
|
-
|
|
44
|
+
### `.bitrise.json`
|
|
32
45
|
|
|
33
46
|
```json
|
|
34
47
|
{
|
|
@@ -38,38 +51,27 @@ The `.bitrise.json` file can be placed in your project root or home directory.
|
|
|
38
51
|
}
|
|
39
52
|
```
|
|
40
53
|
|
|
41
|
-
##
|
|
42
|
-
|
|
43
|
-
### Command Line
|
|
44
|
-
|
|
45
|
-
```bash
|
|
46
|
-
npx bitrise-api-cli@latest download --token abc123 --workflow android-release --slug a1b2c3d4e5f6
|
|
47
|
-
```
|
|
54
|
+
## Main Flags
|
|
48
55
|
|
|
49
|
-
|
|
56
|
+
- `--token <token>`: Bitrise API token
|
|
57
|
+
- `--workflow <name>`: workflow whose latest successful build should be used
|
|
58
|
+
- `--slug <app-slug>`: Bitrise app slug
|
|
59
|
+
- `--artifact <android-apk|ios-ipa>`: artifact type to download
|
|
60
|
+
- `--install`: install the downloaded Android artifact locally
|
|
61
|
+
- `--debug`: print extra request and resolution details
|
|
50
62
|
|
|
51
|
-
|
|
63
|
+
## CI Example
|
|
52
64
|
|
|
53
65
|
```yaml
|
|
54
66
|
steps:
|
|
55
67
|
- script:
|
|
56
68
|
inputs:
|
|
57
69
|
content: |
|
|
58
|
-
npx bitrise-api-cli download \
|
|
70
|
+
npx bitrise-api-cli@latest download \
|
|
59
71
|
--workflow android-release \
|
|
60
|
-
--token $
|
|
72
|
+
--token "$BITRISE_API_CLI_TOKEN"
|
|
61
73
|
```
|
|
62
74
|
|
|
63
|
-
## 📝 License
|
|
64
|
-
|
|
65
|
-
This project is [MIT](LICENSE) licensed.
|
|
66
|
-
|
|
67
|
-
---
|
|
68
|
-
|
|
69
|
-
<div align="center">
|
|
70
|
-
<p>Found this project useful? Give it a ⭐️!</p>
|
|
71
|
-
</div>
|
|
72
|
-
|
|
73
75
|
[npm-image]: https://img.shields.io/npm/v/bitrise-api-cli
|
|
74
76
|
[npm-url]: https://www.npmjs.com/package/bitrise-api-cli
|
|
75
77
|
[npm-dl-stats]: https://img.shields.io/npm/dm/bitrise-api-cli
|