bitrise-api-cli 0.0.1 → 0.0.3

package/README.md

@@ -1,21 +1,119 @@
-# 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> \
+  --app-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)
-  -d, --debug                     output extra debugging (default: false)
-  -h, --help                      display help for command
+  -t, --token <TOKEN>        Bitrise API token
+  -w, --workflow <NAME>      Workflow name
+  -s, --app-slug <SLUG>      Bitrise app slug
+  -d, --debug               Enable debug logging
+  -h, --help                Display help information
+```
+
+## 💡 Examples
+
+### Using Command Line Arguments
+
+```bash
+# Download artifacts from a specific workflow
+npx bitrise-api-cli@latest download \
+  --token abc123 \
+  --workflow android-release \
+  --app-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 \
+  --app-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

@@ -5,17 +5,18 @@ import { Command } from "commander";
 
 // src/bitrise/env.ts
 var ENV = {
-  appSlug: process.env.BITRISE_APP_SLUG ?? "",
+  appSlug: "",
   token: "",
   workflow: ""
 };
 var saveOptions = (options) => {
+  ENV.appSlug = options?.app ?? process.env.BITRISE_APP_SLUG ?? "";
   ENV.token = options?.token ?? process.env.BITRISE_API_CLI_TOKEN ?? "";
   ENV.workflow = options?.workflow ?? process.env.BITRISE_API_CLI_WORKFLOW ?? "";
 };
 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) {
@@ -1528,5 +1529,6 @@ 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.3");
+program.command("download").option("-t, --token <TOKEN>", "bitrise api token (or $BITRISE_API_CLI_TOKEN)").option("-w, --workflow <WORKFLOW_NAME>", "workflow to get apk from (or $BITRISE_API_CLI_WORKFLOW)").option("-a, --app <APP_SLUG>", "bitrise app slug (or $BITRISE_APP_SLUG) see bitrise project url to get slug").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.3",
   "description": "bitrise api CLI wrapper",
   "module": "index",
   "type": "module",