bitrise-api-cli 0.0.4 → 0.0.7

package/README.md

@@ -1,87 +1,42 @@
-# Bitrise API CLI [![npm version](https://badge.fury.io/js/bitrise-api-cli.svg)](https://www.npmjs.com/package/bitrise-api-cli)
+# 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,28 +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

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+import {
+  app,
+  buildContext
+} from "./chunk-4KG3SWIX.js";
+import "./chunk-CF25N4TY.js";
+
+// src/cli/bin/bash-complete.ts
+import { proposeCompletions } from "@stricli/core";
+var inputs = process.argv.slice(3);
+if (process.env["COMP_LINE"]?.endsWith(" ")) {
+  inputs.push("");
+}
+await proposeCompletions(app, inputs, buildContext(process));
+try {
+  for (const { completion } of await proposeCompletions(app, inputs, buildContext(process))) {
+    process.stdout.write(`${completion}
+`);
+  }
+} catch {
+}

package/dist/chunk-4KG3SWIX.js

@@ -0,0 +1,103 @@
+import {
+  validArtifactTypes
+} from "./chunk-CF25N4TY.js";
+
+// src/cli/commands/download/command.ts
+import { buildCommand } from "@stricli/core";
+var downloadCommand = buildCommand({
+  loader: async () => import("./impl-5KTEXOJU.js"),
+  parameters: {
+    flags: {
+      artifact: {
+        kind: "enum",
+        brief: 'bitrise artifact type "ios-ipa" or "android-apk"',
+        default: "android-apk",
+        values: validArtifactTypes
+      },
+      debug: {
+        kind: "boolean",
+        brief: "Number of times to say hello",
+        default: false
+      },
+      slug: {
+        kind: "parsed",
+        brief: "bitrise app slug (or $BITRISE_APP_SLUG) see bitrise project url to get slug",
+        default: process.env["BITRISE_APP_SLUG"],
+        parse: String,
+        placeholder: "APP_SLUG"
+      },
+      token: {
+        kind: "parsed",
+        brief: "bitrise api token (or $BITRISE_API_CLI_TOKEN)",
+        default: process.env["BITRISE_API_CLI_TOKEN"],
+        parse: String,
+        placeholder: "API_TOKEN"
+      },
+      workflow: {
+        kind: "parsed",
+        brief: "workflow to get apk from (or $BITRISE_API_CLI_WORKFLOW)",
+        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: {
+      a: "artifact",
+      d: "debug",
+      s: "slug",
+      t: "token",
+      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.7";
+var description = "bitrise api CLI wrapper";
+
+// src/cli/app.ts
+var root = buildRouteMap({
+  routes: {
+    download: downloadCommand
+  },
+  docs: {
+    brief: description
+  }
+});
+var app = buildApplication(root, {
+  name,
+  versionInfo: {
+    currentVersion: version
+  }
+});
+
+// src/cli/context.ts
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+function buildContext(process2) {
+  return {
+    process: process2,
+    os,
+    fs,
+    path
+  };
+}
+
+export {
+  app,
+  buildContext
+};

package/dist/chunk-CF25N4TY.js

@@ -0,0 +1,6 @@
+// src/cliOptions.types.ts
+var validArtifactTypes = ["android-apk", "ios-ipa"];
+
+export {
+  validArtifactTypes
+};

package/dist/cli.js

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+import {
+  app,
+  buildContext
+} from "./chunk-4KG3SWIX.js";
+import "./chunk-CF25N4TY.js";
+
+// src/cli/bin/cli.ts
+import { run } from "@stricli/core";
+await run(app, process.argv.slice(2), buildContext(process));

package/dist/{bin.js → impl-5KTEXOJU.js}

@@ -1,19 +1,42 @@
-#!/usr/bin/env node
+import {
+  validArtifactTypes
+} from "./chunk-CF25N4TY.js";
 
-// src/bin.ts
-import { Command } from "commander";
+// src/device/install/android.ts
+import { exec } from "teen_process";
+var adbPath = `${process.env.ANDROID_HOME}/platform-tools/adb`;
+var installApk = async (apkPath) => {
+  const { stdout, stderr, code } = await exec(adbPath, ["install", "-r", "-d", apkPath]);
+  if (code !== 0) {
+    console.log(stderr);
+    throw new Error(`Failed to install apk: ${stderr}`);
+  }
+};
 
-// src/cliOptions.types.ts
-var validArtifactTypes = ["android-apk", "ios-ipa"];
+// 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), {
+      text: "installing APK",
+      failText: (error) => `installing APK failed with error: ${error}`
+    });
+  } else {
+    return console.log("Installing on iOS is not supported yet");
+  }
+};
 
 // src/bitrise/env.ts
 var ENV = {
+  debug: false,
   appSlug: "",
   token: "",
   workflow: "",
   artifactType: "android-apk"
 };
 var saveOptions = (options) => {
+  ENV.debug = options.debug;
   ENV.appSlug = options.slug;
   ENV.token = options.token;
   ENV.workflow = options.workflow;
@@ -1435,28 +1458,17 @@ var api = {
   builds: () => new BuildsApi(getApiConfig())
 };
 
+// src/helper/debugLog.ts
+var debugLog = (label, data) => console.log(`${label}: ${JSON.stringify(data, void 0, 2)}`);
+
 // 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;
 };
 
-// src/helper/formatBytes.ts
-var decimals = 0;
-var formatBytes = (bytes) => {
-  if (bytes === 0) return "0 Bytes";
-  const k = 1024;
-  const dm = decimals || 2;
-  const sizes = ["Bytes", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"];
-  const i = Math.floor(Math.log(bytes) / Math.log(k));
-  const formattedSize = Number.parseFloat((bytes / k ** i).toFixed(dm));
-  return `${formattedSize} ${sizes[i]}`;
-};
-
-// src/downloadLatestArtifacts.ts
-import { oraPromise } from "ora";
-
 // src/bitrise/fetchArtifactList.ts
 var fetchArtifactList = async (buildSlug) => {
   const { data } = await api.buildArtifact().artifactList({ appSlug: ENV.appSlug, buildSlug });
@@ -1468,32 +1480,51 @@ var fetchArtifactByType = async (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;
 };
 
-// src/helper/debugLog.ts
-var debugLog = (label, data) => console.log(`${label}: ${JSON.stringify(data, void 0, 2)}`);
-
 // src/bitrise/fetchBuilds.ts
 var getAllBuilds = async () => {
   const { data } = await api.builds().buildList({ appSlug: ENV.appSlug, status: 1 });
   if (!data) throw Error("no build data");
   return data;
 };
-var getLatestBuild = async (options) => {
+var getLatestBuild = async () => {
   const builds = await getAllBuilds();
   const latestBuild = builds.find((build) => build.triggeredWorkflow === ENV.workflow);
   if (!latestBuild) throw `Found no build with the workflow: "${ENV.workflow}"`;
-  if (options.debug) debugLog("latestBuild", latestBuild);
+  if (ENV.debug) debugLog("latestBuild", latestBuild);
   return latestBuild;
 };
 
+// src/helper/formatBytes.ts
+var decimals = 0;
+var formatBytes = (bytes) => {
+  if (bytes === 0) return "0 Bytes";
+  const k = 1024;
+  const dm = decimals || 2;
+  const sizes = ["Bytes", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"];
+  const i = Math.floor(Math.log(bytes) / Math.log(k));
+  const formattedSize = Number.parseFloat((bytes / k ** i).toFixed(dm));
+  return `${formattedSize} ${sizes[i]}`;
+};
+
+// src/downloadLatestArtifacts.ts
+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);
   const response = await new Promise((resolve, reject) => {
     get(url, (res) => {
@@ -1505,54 +1536,44 @@ var downloadFile = async (fileUrl, outputLocationPath) => {
     }).on("error", reject);
   });
   await pipeline(response, createWriteStream(outputLocationPath));
+  return { file: outputLocationPath, duration: formatTime(Date.now() - startTime) };
 };
 
 // src/downloadLatestArtifacts.ts
 var downloadLatestArtifacts = async (options) => {
   saveOptions(options);
   if (!isEnvValid()) return process.exit(1);
-  const latestBuild = await oraPromise(getLatestBuild(options), {
+  const latestBuild = await oraPromise2(getLatestBuild(), {
     text: "fetching latest build",
     failText: (error) => `fetching latest build failed with error: ${error}`
   });
-  if (!latestBuild.slug) {
-    console.log("Latest build contained no Slug");
-    return process.exit(1);
-  }
-  const artifactMetadata = await oraPromise(fetchArtifactByType(latestBuild.slug), {
+  if (!latestBuild.slug) throw Error("Latest build contained no Slug");
+  const artifactMetadata = await oraPromise2(fetchArtifactByType(latestBuild.slug), {
     text: "fetching artifact list",
     failText: (error) => `fetching artifact list failed with error: ${error}`
   });
-  if (options.debug) debugLog("artifactMetadata", artifactMetadata);
-  if (!artifactMetadata || !artifactMetadata.slug) return process.exit(1);
-  const artifact = await oraPromise(
-    fetchArtifact({
-      artifactSlug: artifactMetadata.slug,
-      buildSlug: latestBuild.slug
-    }),
+  if (!artifactMetadata.slug || !artifactMetadata.title) throw Error("Artifact was Invalid");
+  const artifact = await oraPromise2(
+    fetchArtifact({ artifactSlug: artifactMetadata.slug, buildSlug: latestBuild.slug }),
     { text: "fetching artifact metadata" }
   );
-  if (options.debug) debugLog("artifact", artifact);
-  if (!artifact || !artifact.expiringDownloadUrl || !artifactMetadata.title) {
-    console.log("Artifact is missing data");
-    return process.exit(1);
-  }
+  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})`
+  const { file } = await oraPromise2(downloadFile(artifact.expiringDownloadUrl, artifactMetadata.title), {
+    text: `downloading apk file (${fileSize})`,
+    successText: ({ duration }) => `downloading apk file took ${duration}`
   });
+  return file;
 };
 
-// src/bin.ts
-var program = new Command();
-program.version("0.0.4");
-program.command("download").option("-t, --token <TOKEN>", "bitrise api token (or $BITRISE_API_CLI_TOKEN)", process.env.BITRISE_API_CLI_TOKEN).option(
-  "-w, --workflow <WORKFLOW_NAME>",
-  "workflow to get apk from (or $BITRISE_API_CLI_WORKFLOW)",
-  process.env.BITRISE_API_CLI_WORKFLOW
-).option(
-  "-s, --slug <APP_SLUG>",
-  "bitrise app slug (or $BITRISE_APP_SLUG) see bitrise project url to get slug",
-  process.env.BITRISE_APP_SLUG
-).option("-a, --artifact <ARTIFACT_TYPE>", 'bitrise artifact type "ios-ipa" or "android-apk"', "android-apk").option("-d, --debug", "output extra debugging", false).description("Download bitrise artifacts").action((options) => downloadLatestArtifacts(options).catch(() => process.exit(1)));
-program.parse(process.argv);
+// src/cli/commands/download/impl.ts
+async function impl_default(flags) {
+  if (flags.debug) console.log(JSON.stringify(flags, null, 2));
+  const file = await downloadLatestArtifacts(flags);
+  if (flags.install) {
+    await installApp({ file, flags });
+  }
+}
+export {
+  impl_default as default
+};

package/package.json

@@ -1,19 +1,20 @@
 {
   "name": "bitrise-api-cli",
-  "version": "0.0.4",
+  "version": "0.0.7",
   "description": "bitrise api CLI wrapper",
   "module": "index",
   "type": "module",
   "bin": {
-    "bitrise-api-cli": "./dist/bin.js"
+    "bitrise-api-cli": "./dist/cli.js",
+    "__bitrise-api-cli_bash_complete": "dist/bash-complete.js"
   },
-  "keywords": ["bitrise", "bitriseio"],
+  "keywords": ["bitrise", "bitriseio", "apk", "downloader"],
   "license": "MIT",
-  "main": "dist/bin.js",
+  "main": "dist/cli.js",
   "files": ["dist"],
   "scripts": {
     "build": "tsup",
-    "build:dev": "tsup --watch",
+    "build:dev": "tsup --watch --clean false",
     "lint": "bunx biome check --fix",
     "lint:CI": "bunx biome check",
     "typecheck": "tsc",
@@ -22,14 +23,17 @@
     "prepublishOnly": "bun i && bun run lint:CI && tsc  && bun run build"
   },
   "dependencies": {
-    "commander": "13.1.0",
-    "ora": "8.2.0"
+    "@stricli/auto-complete": "1.1.1",
+    "@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.5",
+    "@types/teen_process": "^2.0.4",
+    "tsup": "8.4.0",
     "typescript": "5.7.3"
   }
 }