bitrise-api-cli 0.0.12 → 0.1.0

package/README.md

@@ -1,34 +1,47 @@
-# Bitrise API CLI [![npm][npm-image]][npm-url] ![npm][npm-dl-stats]
+# bitrise-api-cli [![npm][npm-image]][npm-url] ![npm][npm-dl-stats]
 
-🚀 An unofficial CLI tool for Bitrise API artifact downloads.
+Download the latest Bitrise build artifact for a workflow without clicking through the UI.
 
-## 🎯 Features
+`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.
 
-- Download artifacts from successful builds
-- Workflow-based retrieval
-- CI/CD integration
+## Quick Start
 
-## 🚀 Quick Start
+```bash
+npx bitrise-api-cli@latest download \
+  --token <BITRISE_TOKEN> \
+  --workflow <WORKFLOW_NAME> \
+  --slug <APP_SLUG>
+```
+
+## What It Can Download
 
-### Download Artifacts
+- `android-apk` artifacts (default)
+- `ios-ipa` artifacts
+
+For Android artifacts you can also install the downloaded file immediately:
 
 ```bash
-npx bitrise-api-cli@latest download --token <BITRISE_TOKEN> --workflow <WORKFLOW_NAME> [--slug <APP_SLUG>]
+npx bitrise-api-cli@latest download \
+  --artifact android-apk \
+  --install \
+  --token <BITRISE_TOKEN> \
+  --workflow android-release \
+  --slug <APP_SLUG>
 ```
 
-## 🔐 Configuration
+## Configuration
 
-You can combine command-line flags, environment variables, and file-based configuration.
+You can combine command flags, environment variables, and `.bitrise.json`.
 
 ### Environment Variables
 
 - `BITRISE_API_CLI_TOKEN`
 - `BITRISE_API_CLI_WORKFLOW`
-- `BITRISE_APP_SLUG` App Slug (auto-set in Bitrise CI)
+- `BITRISE_APP_SLUG`
 
-### File-Based Configuration
+`BITRISE_APP_SLUG` is usually available automatically in Bitrise CI.
 
-The `.bitrise.json` file can be placed in your project root or home directory.
+### `.bitrise.json`
 
 ```json
 {
@@ -38,38 +51,27 @@ The `.bitrise.json` file can be placed in your project root or home directory.
 }
 ```
 
-## 💡 Examples
-
-### Command Line
-
-```bash
-npx bitrise-api-cli@latest download --token abc123 --workflow android-release --slug a1b2c3d4e5f6
-```
+## Main Flags
 
-### CI/CD Integration
+- `--token <token>`: Bitrise API token
+- `--workflow <name>`: workflow whose latest successful build should be used
+- `--slug <app-slug>`: Bitrise app slug
+- `--artifact <android-apk|ios-ipa>`: artifact type to download
+- `--install`: install the downloaded Android artifact locally
+- `--debug`: print extra request and resolution details
 
-Integrate this CLI tool using the "Script" Step to download artifacts from previous builds, eliminating the need to rebuild from source.
+## CI Example
 
 ```yaml
 steps:
   - script:
       inputs:
         content: |
-          npx bitrise-api-cli download \
+          npx bitrise-api-cli@latest download \
             --workflow android-release \
-            --token $BITRISE_API_TOKEN
+            --token "$BITRISE_API_CLI_TOKEN"
 ```
 
-## 📝 License
-
-This project is [MIT](LICENSE) licensed.
-
----
-
-<div align="center">
-<p>Found this project useful? Give it a ⭐️!</p>
-</div>
-
 [npm-image]: https://img.shields.io/npm/v/bitrise-api-cli
 [npm-url]: https://www.npmjs.com/package/bitrise-api-cli
 [npm-dl-stats]: https://img.shields.io/npm/dm/bitrise-api-cli

package/dist/cli.js

@@ -1,8 +1,13 @@
 #!/usr/bin/env node
 var __defProp = Object.defineProperty;
 var __getOwnPropNames = Object.getOwnPropertyNames;
-var __esm = (fn, res) => function __init() {
-  return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;
+var __esm = (fn, res, err) => function __init() {
+  if (err) throw err[0];
+  try {
+    return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;
+  } catch (e) {
+    throw err = [e], e;
+  }
 };
 var __export = (target, all) => {
   for (var name2 in all)
@@ -119,7 +124,7 @@ var init_oraHelper = __esm({
       failText: (error) => {
         if (isFetchError(error))
           return `${label} failed with HTTP Error ${error.response.status} ${error.response.statusText}`;
-        return `${label} failed with error: ${error.message}`;
+        return `${label} failed with error: ${error instanceof Error ? error.message : String(error)}`;
       },
       successText: (data) => {
         if (data && typeof data === "object" && "duration" in data && typeof data.duration === "number") {
@@ -132,9 +137,9 @@ var init_oraHelper = __esm({
 });
 
 // src/helper/tempDir.ts
-import fs from "node:fs/promises";
-import { tmpdir } from "node:os";
-import path from "node:path";
+import fs from "fs/promises";
+import { tmpdir } from "os";
+import path from "path";
 var createTempDir;
 var init_tempDir = __esm({
   "src/helper/tempDir.ts"() {
@@ -163,8 +168,8 @@ var init_tryCatch = __esm({
 });
 
 // src/device/install/bundletool.ts
-import fs2 from "node:fs/promises";
-import path2 from "node:path";
+import fs2 from "fs/promises";
+import path2 from "path";
 import { oraPromise } from "ora";
 import { $ as $2, which } from "zx";
 var getOrInstallBundletool, bundletoolVersion, bundletoolData, getBundletoolTmpJarPath, $$, getBundleToolJar, installBundleTool;
@@ -208,8 +213,8 @@ var init_bundletool = __esm({
 });
 
 // src/device/install/convertAabToApk.ts
-import fs3 from "node:fs/promises";
-import path3 from "node:path";
+import fs3 from "fs/promises";
+import path3 from "path";
 import { $ as $3 } from "zx";
 var convertAabToApk;
 var init_convertAabToApk = __esm({
@@ -298,6 +303,7 @@ var init_runtime = __esm({
       constructor(configuration = {}) {
         this.configuration = configuration;
       }
+      configuration;
       set config(configuration) {
         this.configuration = configuration;
       }
@@ -346,6 +352,7 @@ var init_runtime = __esm({
         this.configuration = configuration;
         this.middleware = configuration.middleware;
       }
+      configuration;
       static jsonRegex = new RegExp("^(:?application/json|[^;/ 	]+/[^;/ 	]+[+]json)[ 	]*(:?;.*)?$", "i");
       middleware;
       withMiddleware(...middlewares) {
@@ -481,6 +488,7 @@ var init_runtime = __esm({
         super(msg);
         this.response = response;
       }
+      response;
       name = "ResponseError";
     };
     FetchError = class extends Error {
@@ -488,6 +496,7 @@ var init_runtime = __esm({
         super(msg);
         this.cause = cause;
       }
+      cause;
       name = "FetchError";
     };
     RequiredError = class extends Error {
@@ -495,6 +504,7 @@ var init_runtime = __esm({
         super(msg);
         this.field = field;
       }
+      field;
       name = "RequiredError";
     };
     JSONApiResponse = class {
@@ -502,6 +512,8 @@ var init_runtime = __esm({
         this.raw = raw;
         this.transformer = transformer;
       }
+      raw;
+      transformer;
       async value() {
         return this.transformer(await this.raw.json());
       }
@@ -510,6 +522,7 @@ var init_runtime = __esm({
       constructor(raw) {
         this.raw = raw;
       }
+      raw;
       async value() {
         return void 0;
       }
@@ -518,6 +531,7 @@ var init_runtime = __esm({
       constructor(raw) {
         this.raw = raw;
       }
+      raw;
       async value() {
         return await this.raw.text();
       }
@@ -3531,10 +3545,10 @@ var init_fetchBuilds = __esm({
 });
 
 // src/helper/downloadFile.ts
-import { createWriteStream } from "node:fs";
-import { get } from "node:https";
-import { pipeline } from "node:stream/promises";
-import { URL } from "node:url";
+import { createWriteStream } from "fs";
+import { get } from "https";
+import { pipeline } from "stream/promises";
+import { URL } from "url";
 var downloadFile;
 var init_downloadFile = __esm({
   "src/helper/downloadFile.ts"() {
@@ -3587,7 +3601,7 @@ var init_downloadLatestArtifacts = __esm({
     init_downloadFile();
     init_formatBytes();
     init_oraHelper();
-    downloadLatestArtifacts = async (options) => {
+    downloadLatestArtifacts = async (_options) => {
       const latestBuild = await oraPromise3(getLatestBuild(), getOraTexts("fetching latest build"));
       const artifactMetadata = await oraPromise3(
         fetchArtifactByType(latestBuild.slug),
@@ -3631,8 +3645,12 @@ var init_impl = __esm({
 // src/cli/bin/cli.ts
 import { run } from "@stricli/core";
 
+// src/cli/app.ts
+import { buildApplication, buildRouteMap } from "@stricli/core";
+
 // src/cli/commands/download/command.ts
 init_cliOptions_types();
+import { buildCommand } from "@stricli/core";
 
 // src/config/readConfig.ts
 import { cosmiconfigSync } from "cosmiconfig";
@@ -3649,7 +3667,6 @@ var readConfig = () => {
 };
 
 // src/cli/commands/download/command.ts
-import { buildCommand } from "@stricli/core";
 var downloadCommand = buildCommand({
   loader: async () => Promise.resolve().then(() => (init_impl(), impl_exports)),
   parameters: {
@@ -3706,13 +3723,10 @@ var downloadCommand = buildCommand({
   }
 });
 
-// src/cli/app.ts
-import { buildApplication, buildRouteMap } from "@stricli/core";
-
 // package.json
 var name = "bitrise-api-cli";
-var version = "0.0.12";
-var description = "bitrise api CLI wrapper";
+var version = "0.1.0";
+var description = "Download the latest Bitrise build artifacts for a workflow from the command line.";
 
 // src/cli/app.ts
 var root = buildRouteMap({

package/package.json

@@ -1,16 +1,39 @@
 {
   "name": "bitrise-api-cli",
-  "version": "0.0.12",
-  "description": "bitrise api CLI wrapper",
+  "version": "0.1.0",
+  "description": "Download the latest Bitrise build artifacts for a workflow from the command line.",
   "module": "index",
   "type": "module",
   "bin": {
-    "bitrise-api-cli": "./dist/cli.js"
+    "bitrise-api-cli": "dist/cli.js"
+  },
+  "keywords": [
+    "bitrise",
+    "bitriseio",
+    "ci",
+    "artifacts",
+    "apk",
+    "ipa",
+    "download",
+    "cli"
+  ],
+  "author": {
+    "name": "WookieFPV (Lukas Müller)",
+    "url": "https://github.com/WookieFPV"
   },
-  "keywords": ["bitrise", "bitriseio", "apk", "downloader"],
   "license": "MIT",
   "main": "dist/cli.js",
-  "files": ["dist"],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/WookieFPV/bitrise-api-cli.git"
+  },
+  "homepage": "https://github.com/WookieFPV/bitrise-api-cli#readme",
+  "bugs": {
+    "url": "https://github.com/WookieFPV/bitrise-api-cli/issues"
+  },
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "tsup",
     "build:dev": "tsup --watch --clean false",
@@ -22,18 +45,30 @@
     "prepublishOnly": "bun i && bun run lint:CI && tsc  && bun run build"
   },
   "dependencies": {
-    "@stricli/core": "1.1.2",
-    "cosmiconfig": "9.0.0",
-    "ora": "8.2.0",
-    "zx": "8.5.3"
+    "@stricli/core": "1.3.0",
+    "cosmiconfig": "9.0.2",
+    "ora": "9.4.1",
+    "zx": "8.8.5"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.9.4",
-    "@openapitools/openapi-generator-cli": "2.19.1",
+    "@biomejs/biome": "2.5.5",
+    "@openapitools/openapi-generator-cli": "2.40.0",
     "@total-typescript/ts-reset": "0.6.1",
-    "@types/bun": "latest",
-    "lefthook": "1.11.11",
-    "tsup": "8.4.0",
-    "typescript": "5.8.3"
+    "@types/bun": "1.3.14",
+    "lefthook": "2.1.10",
+    "tsup": "8.5.1",
+    "typescript": "7.0.2"
+  },
+  "overrides": {
+    "brace-expansion": "2.1.2",
+    "esbuild": "0.28.1",
+    "form-data": "4.0.6",
+    "glob": "10.5.0",
+    "ip-address": "10.2.0",
+    "js-yaml": "4.3.0",
+    "minimatch": "9.0.9",
+    "picomatch": "4.0.4",
+    "rollup": "4.60.4",
+    "shell-quote": "1.9.0"
   }
 }