bitrise-api-cli 0.0.1 → 0.0.4

package/README.md

@@ -1,21 +1,120 @@
-# bitrise_api_cli
+# Bitrise API CLI [![npm version](https://badge.fury.io/js/bitrise-api-cli.svg)](https://www.npmjs.com/package/bitrise-api-cli)
 
-Unofficial CLI to download artifacts from bitrise.
-This is used to download apk instead of building from source each time.
+<div align="center">
+🚀 An unofficial CLI tool to interact with Bitrise API, making artifact downloads a breeze.
+</div>
 
-## Usage
+## 🎯 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
+
+## 🚀 Quick Start
+
+### Download Artifacts
 
 ```bash
+# Using npx (recommended)
 npx bitrise-api-cli@latest download --token <BITRISE_TOKEN> --workflow <WORKFLOW_NAME>
 
-Usage: bitrise-api-cli download [options]
+# 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>
+```
+
+## 🔐 Configuration
 
-Download bitrise artifacts
+### 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 |
+
+### 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
+```
+
+## 💡 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
+
+```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
 ```
+
+## 🔍 Common Use Cases
+
+### CI/CD Integration
+
+Perfect for downloading artifacts from previous builds instead of rebuilding from source:
+
+```yaml
+steps:
+  - script:
+      inputs:
+        content: |
+          npx bitrise-api-cli download \
+            --workflow android-release \
+            --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>

package/dist/bin.js

@@ -3,19 +3,25 @@
 // src/bin.ts
 import { Command } from "commander";
 
+// src/cliOptions.types.ts
+var validArtifactTypes = ["android-apk", "ios-ipa"];
+
 // src/bitrise/env.ts
 var ENV = {
-  appSlug: process.env.BITRISE_APP_SLUG ?? "",
+  appSlug: "",
   token: "",
-  workflow: ""
+  workflow: "",
+  artifactType: "android-apk"
 };
 var saveOptions = (options) => {
-  ENV.token = options?.token ?? process.env.BITRISE_API_CLI_TOKEN ?? "";
-  ENV.workflow = options?.workflow ?? process.env.BITRISE_API_CLI_WORKFLOW ?? "";
+  ENV.appSlug = options.slug;
+  ENV.token = options.token;
+  ENV.workflow = options.workflow;
+  ENV.artifactType = options.artifact;
 };
 var isEnvValid = () => {
   if (ENV.appSlug.length < 1) {
-    console.log("No AppSlug provided! (use $BITRISE_APP_SLUG env variable)");
+    console.log("No app slug provided! (see --help for more information)");
     return false;
   }
   if (ENV.token?.length < 1) {
@@ -26,6 +32,10 @@ var isEnvValid = () => {
     console.log("No workflow provided! (see --help for more information)");
     return false;
   }
+  if (!validArtifactTypes.includes(ENV.artifactType)) {
+    console.log(`Invalid artifact type "${ENV.artifactType}"! (see --help for more information)`);
+    return false;
+  }
   return true;
 };
 
@@ -1453,13 +1463,20 @@ var fetchArtifactList = async (buildSlug) => {
   if (!data) throw new Error("buildArtifact().artifactList returned no data");
   return data;
 };
+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}`);
+  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 });
+  const { data } = await api.builds().buildList({ appSlug: ENV.appSlug, status: 1 });
   if (!data) throw Error("no build data");
   return data;
 };
@@ -1491,7 +1508,6 @@ var downloadFile = async (fileUrl, outputLocationPath) => {
 };
 
 // src/downloadLatestArtifacts.ts
-var targetArtifactType = "android-apk";
 var downloadLatestArtifacts = async (options) => {
   saveOptions(options);
   if (!isEnvValid()) return process.exit(1);
@@ -1503,11 +1519,12 @@ var downloadLatestArtifacts = async (options) => {
     console.log("Latest build contained no Slug");
     return process.exit(1);
   }
-  const artifactInfo = await oraPromise(fetchArtifactList(latestBuild.slug), { text: "fetching artifact list" });
-  const artifactMetadata = artifactInfo.find((artifact2) => artifact2.artifactType === targetArtifactType);
-  if (!artifactMetadata || !artifactMetadata.slug)
-    throw new Error(`Found no apk in build #${latestBuild.buildNumber}`);
+  const artifactMetadata = await oraPromise(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,
@@ -1528,5 +1545,14 @@ var downloadLatestArtifacts = async (options) => {
 
 // src/bin.ts
 var program = new Command();
-program.command("download").option("-t, --token <TOKEN>", "bitrise api token (or use env variable BITRISE_API_CLI_TOKEN)", void 0).option("-w, --workflow <WORKFLOW_NAME>", "workflow to get apk from (or use env variable BITRISE_API_CLI_WORKFLOW)").option("-d, --debug", "output extra debugging", false).description("Download bitrise artifacts").action((options) => downloadLatestArtifacts(options).catch(() => process.exit(1)));
+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);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bitrise-api-cli",
-  "version": "0.0.1",
+  "version": "0.0.4",
   "description": "bitrise api CLI wrapper",
   "module": "index",
   "type": "module",