bitrise-api-cli 0.0.6 → 0.0.8

package/README.md

@@ -1,87 +1,42 @@
 # Bitrise API CLI [![npm][npm-image]][npm-url] ![npm][npm-dl-stats]
 
-<div align="center">
-🚀 An unofficial CLI tool to interact with Bitrise API, making artifact downloads a breeze.
-</div>
+🚀 An unofficial CLI tool for Bitrise API artifact downloads.
 
 ## 🎯 Features
 
-- Download artifacts from your latest successful builds
-- Simple workflow-based artifact retrieval
-- Easy integration with CI/CD pipelines
-- Supports both CLI arguments and environment variables
+- Download artifacts from successful builds
+- Workflow-based retrieval
+- CI/CD integration
 
 ## 🚀 Quick Start
 
 ### Download Artifacts
 
 ```bash
-# Using npx (recommended)
-npx bitrise-api-cli@latest download --token <BITRISE_TOKEN> --workflow <WORKFLOW_NAME>
-
-# If running locally, you'll need to specify the app slug
-npx bitrise-api-cli@latest download \
-  --token <BITRISE_TOKEN> \
-  --workflow <WORKFLOW_NAME> \
-  --slug <APP_SLUG>
+npx bitrise-api-cli@latest download --token <BITRISE_TOKEN> --workflow <WORKFLOW_NAME> [--slug <APP_SLUG>]
 ```
 
 ## 🔐 Configuration
 
-### Environment Variables
-
-| Variable                   | Description                              | Required     |
-| -------------------------- | ---------------------------------------- |--------------|
-| `BITRISE_API_CLI_TOKEN`    | Your Bitrise API token                   | Yes          |
-| `BITRISE_API_CLI_WORKFLOW` | Workflow name to download artifacts from | Yes          |
-| `BITRISE_APP_SLUG`         | App Slug (auto-set in Bitrise CI)        | only locally |
+### Environment Variables (instead of CLI flags)
 
-### CLI Options
-
-```bash
-Options:
-  -t, --token <TOKEN>             bitrise api token (or $BITRISE_API_CLI_TOKEN)
-  -w, --workflow <WORKFLOW_NAME>  workflow to get apk from (or $BITRISE_API_CLI_WORKFLOW)
-  -s, --slug <APP_SLUG>           bitrise app slug (or $BITRISE_APP_SLUG) see bitrise project url to get slug
-  -a, --artifact <ARTIFACT_TYPE>  bitrise artifact type "ios-ipa" or "android-apk"
-  -d, --debug                     output extra debugging (default: false)
-  -h, --help                      display help for command
-```
+| Variable                   | Description                          | Required     |
+| -------------------------- | ------------------------------------ | ------------ |
+| `BITRISE_API_CLI_TOKEN`    | Your Bitrise API token               | Yes          |
+| `BITRISE_API_CLI_WORKFLOW` | Workflow name for artifact downloads | Yes          |
+| `BITRISE_APP_SLUG`         | App Slug (auto-set in Bitrise CI)    | Locally only |
 
 ## 💡 Examples
 
-### Using Command Line Arguments
-
-```bash
-# Download artifacts from a specific workflow
-npx bitrise-api-cli@latest download \
-  --token abc123 \
-  --workflow android-release \
-  --slug a1b2c3d4e5f6
-
-# Enable debug logging
-npx bitrise-api-cli@latest download --debug \
-  --token abc123 \
-  --workflow android-release
-```
-
-### Using Environment Variables
+### Command Line
 
 ```bash
-# Set environment variables
-export BITRISE_API_CLI_TOKEN=abc123
-export BITRISE_API_CLI_WORKFLOW=android-release
-export BITRISE_APP_SLUG=a1b2c3d4e5f6
-
-# Run the command
-npx bitrise-api-cli@latest download
+npx bitrise-api-cli@latest download --token abc123 --workflow android-release --slug a1b2c3d4e5f6
 ```
 
-## 🔍 Common Use Cases
-
 ### CI/CD Integration
 
-Perfect for downloading artifacts from previous builds instead of rebuilding from source:
+Integrate this CLI tool using the "Script" Step to download artifacts from previous builds, eliminating the need to rebuild from source.
 
 ```yaml
 steps:
@@ -93,33 +48,16 @@ steps:
             --token $BITRISE_API_TOKEN
 ```
 
-### Local Development
-
-Download the latest artifacts to test without building:
-
-```bash
-npx bitrise-api-cli@latest download \
-  --token $BITRISE_API_TOKEN \
-  --workflow android-release \
-  --slug $BITRISE_APP_SLUG
-```
-
 ## 📝 License
 
 This project is [MIT](LICENSE) licensed.
 
-## 🙏 Acknowledgments
-
-- Thanks to [Bitrise](https://www.bitrise.io/) for their excellent API
-- Built with ❤️ for the mobile CI/CD community
-
 ---
 
 <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/bash-complete.js

@@ -2,7 +2,7 @@
 import {
   app,
   buildContext
-} from "./chunk-SUHWPUKK.js";
+} from "./chunk-WFYIERBR.js";
 import "./chunk-CF25N4TY.js";
 
 // src/cli/bin/bash-complete.ts

package/dist/{chunk-SUHWPUKK.js → chunk-WFYIERBR.js}

@@ -2,17 +2,10 @@ import {
   validArtifactTypes
 } from "./chunk-CF25N4TY.js";
 
-// src/cli/app.ts
-import { buildApplication, buildCommand, buildRouteMap } from "@stricli/core";
-
-// package.json
-var name = "bitrise-api-cli";
-var version = "0.0.6";
-var description = "bitrise api CLI wrapper";
-
-// src/cli/app.ts
+// src/cli/commands/download/command.ts
+import { buildCommand } from "@stricli/core";
 var downloadCommand = buildCommand({
-  loader: async () => import("./impl-ESKLIOQY.js"),
+  loader: async () => import("./impl-PVD6QYYZ.js"),
   parameters: {
     flags: {
       artifact: {
@@ -46,6 +39,11 @@ var downloadCommand = buildCommand({
         default: process.env["BITRISE_API_CLI_WORKFLOW"],
         parse: String,
         placeholder: "WORKFLOW_NAME"
+      },
+      install: {
+        kind: "boolean",
+        brief: "Install the downloaded artifact [android only]",
+        default: false
       }
     },
     aliases: {
@@ -53,13 +51,24 @@ var downloadCommand = buildCommand({
       d: "debug",
       s: "slug",
       t: "token",
-      w: "workflow"
+      w: "workflow",
+      i: "install"
     }
   },
   docs: {
     brief: "Download bitrise artifacts. Most parameters can be set via environment variables."
   }
 });
+
+// src/cli/app.ts
+import { buildApplication, buildRouteMap } from "@stricli/core";
+
+// package.json
+var name = "bitrise-api-cli";
+var version = "0.0.8";
+var description = "bitrise api CLI wrapper";
+
+// src/cli/app.ts
 var root = buildRouteMap({
   routes: {
     download: downloadCommand

package/dist/cli.js

@@ -2,7 +2,7 @@
 import {
   app,
   buildContext
-} from "./chunk-SUHWPUKK.js";
+} from "./chunk-WFYIERBR.js";
 import "./chunk-CF25N4TY.js";
 
 // src/cli/bin/cli.ts

package/dist/{impl-ESKLIOQY.js → impl-PVD6QYYZ.js}

@@ -36,6 +36,55 @@ var isEnvValid = () => {
   }
   return true;
 };
+var setupEnv = (flags) => {
+  if (flags.debug) console.log(JSON.stringify(flags, null, 2));
+  saveOptions(flags);
+  return isEnvValid();
+};
+
+// src/device/install/android.ts
+import { exec } from "teen_process";
+var adbPath = `${process.env.ANDROID_HOME}/platform-tools/adb`;
+var installApk = async (apkPath) => {
+  const startTime = Date.now();
+  try {
+    const { stdout, stderr, code } = await exec(adbPath, ["install", "-r", "-d", apkPath]);
+    if (code !== 0) throw new Error(`Failed to install apk error code: ${code}`);
+    return { duration: Date.now() - startTime };
+  } catch (e) {
+    if (e instanceof Error && "stderr" in e) throw new Error(`${e.stderr}`);
+    throw new Error("unknown Error");
+  }
+};
+
+// src/helper/formatTime.ts
+var formatTime = (timeMs) => {
+  if (timeMs < 1e3) return `${timeMs}ms`;
+  return `${(timeMs / 1e3).toFixed(1)}s`;
+};
+
+// src/helper/oraHelper.ts
+var getOraTexts = (label) => ({
+  text: label,
+  failText: (error) => `${label} failed with error: ${error.message}`,
+  successText: (data) => {
+    if (data && typeof data === "object" && "duration" in data && typeof data.duration === "number") {
+      return `${label} [took ${formatTime(data.duration)}]`;
+    }
+    return label;
+  }
+});
+
+// src/device/install/run.ts
+import { oraPromise } from "ora";
+var installApp = async ({ file, flags }) => {
+  if (flags.artifact === "android-apk") {
+    if (!file.endsWith(".apk")) return console.log("Artifact is not an APK file");
+    await oraPromise(installApk(file), getOraTexts("installing APK"));
+  } else {
+    return console.log("Installing on iOS is not supported yet");
+  }
+};
 
 // src/generated_api/runtime.ts
 var BASE_PATH = "https://api.bitrise.io/v0.1".replace(/\/+$/, "");
@@ -1436,12 +1485,20 @@ var api = {
 // src/helper/debugLog.ts
 var debugLog = (label, data) => console.log(`${label}: ${JSON.stringify(data, void 0, 2)}`);
 
+// src/helper/ensureMandatoryFields.ts
+var ensureMandatoryFields = (input, mandatory) => {
+  for (const field of mandatory) {
+    if (!input[field]) throw new Error(`Missing mandatory field: ${String(field)}`);
+  }
+  return input;
+};
+
 // src/bitrise/fetchArtifact.ts
 var fetchArtifact = async ({ artifactSlug, buildSlug }) => {
   const { data } = await api.buildArtifact().artifactShow({ appSlug: ENV.appSlug, artifactSlug, buildSlug });
   if (!data) throw new Error("buildArtifact().artifactShow returned no data");
   if (ENV.debug) debugLog("artifact", data);
-  return data;
+  return ensureMandatoryFields(data, ["expiringDownloadUrl"]);
 };
 
 // src/bitrise/fetchArtifactList.ts
@@ -1453,10 +1510,9 @@ var fetchArtifactList = async (buildSlug) => {
 var fetchArtifactByType = async (buildSlug) => {
   const artifactInfo = await fetchArtifactList(buildSlug);
   const artifactMetadata = artifactInfo.find((artifact) => artifact.artifactType === ENV.artifactType);
-  if (!artifactMetadata || !artifactMetadata.slug)
-    throw new Error(`Found no ${ENV.artifactType} in build Slug: ${buildSlug}`);
   if (ENV.debug) debugLog("artifactMetadata", artifactMetadata);
-  return artifactMetadata;
+  if (!artifactMetadata) throw new Error(`Found no ${ENV.artifactType} in build Slug: ${buildSlug}`);
+  return ensureMandatoryFields(artifactMetadata, ["slug", "title"]);
 };
 
 // src/bitrise/fetchBuilds.ts
@@ -1470,7 +1526,7 @@ var getLatestBuild = async () => {
   const latestBuild = builds.find((build) => build.triggeredWorkflow === ENV.workflow);
   if (!latestBuild) throw `Found no build with the workflow: "${ENV.workflow}"`;
   if (ENV.debug) debugLog("latestBuild", latestBuild);
-  return latestBuild;
+  return ensureMandatoryFields(latestBuild, ["slug"]);
 };
 
 // src/helper/formatBytes.ts
@@ -1486,18 +1542,13 @@ var formatBytes = (bytes) => {
 };
 
 // src/downloadLatestArtifacts.ts
-import { oraPromise } from "ora";
+import { oraPromise as oraPromise2 } from "ora";
 
 // 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";
-
-// src/helper/formatTime.ts
-var formatTime = (timeMs) => `${(timeMs / 1e3).toFixed(1)}s`;
-
-// src/helper/downloadFile.ts
 var downloadFile = async (fileUrl, outputLocationPath) => {
   const startTime = Date.now();
   const url = new URL(fileUrl);
@@ -1511,39 +1562,35 @@ var downloadFile = async (fileUrl, outputLocationPath) => {
     }).on("error", reject);
   });
   await pipeline(response, createWriteStream(outputLocationPath));
-  return { duration: formatTime(Date.now() - startTime) };
+  return { file: outputLocationPath, duration: Date.now() - startTime };
 };
 
 // src/downloadLatestArtifacts.ts
 var downloadLatestArtifacts = async (options) => {
-  saveOptions(options);
-  if (!isEnvValid()) return process.exit(1);
-  const latestBuild = await oraPromise(getLatestBuild(), {
-    text: "fetching latest build",
-    failText: (error) => `fetching latest build failed with error: ${error}`
-  });
-  if (!latestBuild.slug) throw Error("Latest build contained no Slug");
-  const artifactMetadata = await oraPromise(fetchArtifactByType(latestBuild.slug), {
-    text: "fetching artifact list",
-    failText: (error) => `fetching artifact list failed with error: ${error}`
-  });
-  if (!artifactMetadata.slug || !artifactMetadata.title) throw Error("Artifact was Invalid");
-  const artifact = await oraPromise(
+  const latestBuild = await oraPromise2(getLatestBuild(), getOraTexts("fetching latest build"));
+  const artifactMetadata = await oraPromise2(
+    fetchArtifactByType(latestBuild.slug),
+    getOraTexts("fetching artifact list")
+  );
+  const artifact = await oraPromise2(
     fetchArtifact({ artifactSlug: artifactMetadata.slug, buildSlug: latestBuild.slug }),
-    { text: "fetching artifact metadata" }
+    getOraTexts("fetching artifact metadata")
   );
-  if (!artifact.expiringDownloadUrl) throw Error("Artifact is missing expiringDownloadUrl");
-  const fileSize = formatBytes(artifact.fileSizeBytes ?? 0);
-  await oraPromise(downloadFile(artifact.expiringDownloadUrl, artifactMetadata.title), {
-    text: `downloading apk file (${fileSize})`,
-    successText: ({ duration }) => `downloading apk file took ${duration}`
+  const { file } = await oraPromise2(downloadFile(artifact.expiringDownloadUrl, artifactMetadata.title), {
+    ...getOraTexts("downloading apk file"),
+    text: `downloading apk file [${formatBytes(artifact.fileSizeBytes ?? 0)}]`
   });
+  return file;
 };
 
-// src/cli/impl.ts
+// src/cli/commands/download/impl.ts
 async function impl_default(flags) {
-  if (flags.debug) console.log(JSON.stringify(flags, null, 2));
-  return downloadLatestArtifacts(flags);
+  if (!setupEnv(flags)) return process.exit(1);
+  const file = await downloadLatestArtifacts(flags);
+  if (flags.install) {
+    await installApp({ file, flags }).catch(() => {
+    });
+  }
 }
 export {
   impl_default as default

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bitrise-api-cli",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "bitrise api CLI wrapper",
   "module": "index",
   "type": "module",
@@ -23,15 +23,17 @@
     "prepublishOnly": "bun i && bun run lint:CI && tsc  && bun run build"
   },
   "dependencies": {
-    "@stricli/core": "1.1.1",
     "@stricli/auto-complete": "1.1.1",
-    "ora": "8.2.0"
+    "@stricli/core": "1.1.1",
+    "ora": "8.2.0",
+    "teen_process": "2.2.3"
   },
   "devDependencies": {
     "@biomejs/biome": "1.9.4",
     "@openapitools/openapi-generator-cli": "2.16.3",
     "@types/bun": "latest",
-    "tsup": "8.3.6",
+    "@types/teen_process": "^2.0.4",
+    "tsup": "8.4.0",
     "typescript": "5.7.3"
   }
 }