@heroku-cli/heroku-slugs 2.0.0

package/LICENSE

@@ -0,0 +1,7 @@
+The ISC License (ISC)
+
+Copyright © Heroku 2025
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,101 @@
+# Heroku Slugs CLI Plugin
+
+This plugin adds commands to the Heroku CLI for downloading slugs
+
+## Commands
+
+```
+$ heroku slugs -a appname
+Slugs in appname
+v24: 00000000-bbbb-cccc-dddd-eeeeeeeeeeee
+v23: 11111111-bbbb-cccc-dddd-eeeeeeeeeeee
+v22: 22222222-bbbb-cccc-dddd-eeeeeeeeeeee
+v21: 33333333-bbbb-cccc-dddd-eeeeeeeeeeee
+
+$ heroku slugs:download 00000000-bbbb-cccc-dddd-eeeeeeeeeeee -a appname
+```
+
+This will download the Slug directly from our filestore on S3
+
+## Using a proxy
+
+```
+$ export HEROKU_HTTP_PROXY_HOST=<your-proxy-host>
+$ export HEROKU_HTTP_PROXY_PORT=<your-proxy-port>
+$ heroku slugs:download 00000000-bbbb-cccc-dddd-eeeeeeeeeeee -a appname
+```
+
+<!-- toc -->
+* [Heroku Slugs CLI Plugin](#heroku-slugs-cli-plugin)
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+
+# Usage
+  <!-- usage -->
+```sh-session
+$ npm install -g @heroku-cli/heroku-slugs
+$ heroku COMMAND
+running command...
+$ heroku (--version)
+@heroku-cli/heroku-slugs/2.0.0 darwin-x64 node-v20.18.3
+$ heroku --help [COMMAND]
+USAGE
+  $ heroku COMMAND
+...
+```
+<!-- usagestop -->
+
+# Commands
+  <!-- commands -->
+* [`heroku slugs`](#heroku-slugs)
+* [`heroku slugs:download [SLUG]`](#heroku-slugsdownload-slug)
+
+## `heroku slugs`
+
+list recent slugs on application
+
+```
+USAGE
+  $ heroku slugs -a <value> [-r <value>]
+
+FLAGS
+  -a, --app=<value>     (required) app to run command against
+  -r, --remote=<value>  git remote of app to use
+
+DESCRIPTION
+  list recent slugs on application
+
+EXAMPLES
+  $ heroku slugs --app myapp
+```
+
+_See code: [src/commands/slugs/index.ts](https://github.com/heroku/heroku-slugs/blob/v2.0.0/src/commands/slugs/index.ts)_
+
+## `heroku slugs:download [SLUG]`
+
+download a slug's tarball to <APP_NAME>/slug.tar.gz and then extract the slug
+
+```
+USAGE
+  $ heroku slugs:download [SLUG] -a <value> [-e] [-r <value>]
+
+ARGUMENTS
+  SLUG  name or ID of slug
+
+FLAGS
+  -a, --app=<value>      (required) app to run command against
+  -e, --no-extract-slug  skip extracting slug after download
+  -r, --remote=<value>   git remote of app to use
+
+DESCRIPTION
+  download a slug's tarball to <APP_NAME>/slug.tar.gz and then extract the slug
+
+EXAMPLES
+  $ heroku slugs:download --app example-app v2
+
+  $ heroku slugs:download --app example-app v2 --no-extract-slug
+```
+
+_See code: [src/commands/slugs/download.ts](https://github.com/heroku/heroku-slugs/blob/v2.0.0/src/commands/slugs/download.ts)_
+<!-- commandsstop -->

package/dist/commands/slugs/download.d.ts

@@ -0,0 +1,14 @@
+import { Command } from '@heroku-cli/command';
+export default class SlugsDownload extends Command {
+    static args: {
+        slug: import("@oclif/core/lib/interfaces/parser").Arg<string | undefined, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        app: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        'no-extract-slug': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        remote: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/slugs/download.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const command_1 = require("@heroku-cli/command");
+const notifications_1 = require("@heroku-cli/notifications");
+const core_1 = require("@oclif/core");
+const node_child_process_1 = require("node:child_process");
+const download_1 = require("../../lib/download");
+class SlugsDownload extends command_1.Command {
+    async run() {
+        var _a;
+        const { args, flags } = await this.parse(SlugsDownload);
+        const { app } = flags;
+        const { slug } = args;
+        const noExtractSlug = flags['no-extract-slug'];
+        let id = slug;
+        if (!id) {
+            const { body: releases } = await this.heroku.get(`/apps/${app}/releases`, {
+                headers: {
+                    Range: 'version ..; order=desc',
+                },
+            });
+            const currentRelease = releases.find(r => r.slug);
+            id = (_a = currentRelease === null || currentRelease === void 0 ? void 0 : currentRelease.slug) === null || _a === void 0 ? void 0 : _a.id;
+        }
+        if (!id) {
+            core_1.ux.error('No slug found. Specify the slug to download by its name or ID.');
+        }
+        const { body: appSlug } = await this.heroku.get(`/apps/${app}/slugs/${id}`);
+        if (!appSlug.blob || !appSlug.blob.url) {
+            this.error('This slug has no blob to download.');
+        }
+        core_1.ux.log(`Downloading slug ${id} to ${app}/slug.tar.gz`);
+        const downloadStarted = Date.now();
+        (0, node_child_process_1.execSync)(`mkdir ${app}`);
+        await (0, download_1.download)(appSlug.blob.url, `${app}/slug.tar.gz`, { progress: true });
+        if (!noExtractSlug) {
+            core_1.ux.action.start(`Extracting ${app}/slug.tar.gz`);
+            (0, node_child_process_1.execSync)(`tar -xf ${app}/slug.tar.gz -C ${app}`);
+            core_1.ux.action.stop();
+        }
+        const downloadTime = Date.now() - downloadStarted;
+        if (downloadTime > 10 * 1000) {
+            const notification = {
+                message: 'download is finished',
+                subtitle: 'heroku slugs:download',
+                title: app,
+            };
+            (0, notifications_1.notify)(notification);
+        }
+    }
+}
+SlugsDownload.args = {
+    slug: core_1.Args.string({ description: 'name or ID of slug' }),
+};
+SlugsDownload.description = "download a slug's tarball to <APP_NAME>/slug.tar.gz and then extract the slug";
+SlugsDownload.examples = [
+    '$ heroku slugs:download --app example-app v2',
+    '$ heroku slugs:download --app example-app v2 --no-extract-slug',
+];
+SlugsDownload.flags = {
+    app: command_1.flags.app({ required: true }),
+    'no-extract-slug': command_1.flags.boolean({ char: 'e', default: false, description: 'skip extracting slug after download' }),
+    remote: command_1.flags.remote(),
+};
+exports.default = SlugsDownload;

package/dist/commands/slugs/index.d.ts

@@ -0,0 +1,10 @@
+import { Command } from '@heroku-cli/command';
+export default class SlugsIndex extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        app: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        remote: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/slugs/index.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const color_1 = require("@heroku-cli/color");
+const command_1 = require("@heroku-cli/command");
+const core_1 = require("@oclif/core");
+class SlugsIndex extends command_1.Command {
+    async run() {
+        var _a;
+        const { flags } = await this.parse(SlugsIndex);
+        const { app } = flags;
+        const { body: releases } = await this.heroku.get(`/apps/${app}/releases`, {
+            headers: {
+                Range: 'version ..; order=desc',
+            },
+        });
+        core_1.ux.styledHeader(`${color_1.default.app(app)} Slugs`);
+        for (const r of releases.filter(r => r.slug))
+            core_1.ux.log(`v${r.version}: ${(_a = r.slug) === null || _a === void 0 ? void 0 : _a.id}`);
+    }
+}
+SlugsIndex.description = 'list recent slugs on application';
+SlugsIndex.examples = [
+    '$ heroku slugs --app myapp',
+];
+SlugsIndex.flags = {
+    app: command_1.flags.app({ required: true }),
+    remote: command_1.flags.remote(),
+};
+exports.default = SlugsIndex;

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/dist/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {};

package/dist/lib/download.d.ts

@@ -0,0 +1,3 @@
+export declare function download(url: string, path: string, opts: {
+    progress: any;
+}): Promise<unknown>;

package/dist/lib/download.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.download = download;
+const https = require("https");
+const fs = require("node:fs");
+const Path = require("node:path");
+const progress = require('smooth-progress');
+const bytes = require('bytes');
+// eslint-disable-next-line n/no-extraneous-require
+const tunnel = require('tunnel-agent');
+function download(url, path, opts) {
+    return new Promise((fulfill, reject) => {
+        fs.mkdirSync(Path.dirname(path), { recursive: true });
+        const file = fs.createWriteStream(path);
+        const agent = makeAgent();
+        https.get(url, { agent }, (rsp) => {
+            if (opts.progress)
+                showProgress(rsp);
+            rsp.pipe(file)
+                .on('error', reject)
+                .on('close', fulfill);
+        });
+    });
+}
+function makeAgent() {
+    const host = process.env.HEROKU_HTTP_PROXY_HOST;
+    if (!host) {
+        return;
+    }
+    const port = process.env.HEROKU_HTTP_PROXY_PORT || 8080;
+    const auth = process.env.HEROKU_HTTP_PROXY_AUTH;
+    const opts = { proxy: { host, port, proxyAuth: auth } };
+    return tunnel.httpsOverHttp(opts);
+}
+function showProgress(rsp) {
+    const bar = progress({
+        tmpl: 'Downloading... :bar :percent :eta :data',
+        total: parseInt(rsp.headers['content-length'], 10),
+        width: 25,
+    });
+    let total = 0;
+    rsp.on('data', (chunk) => {
+        total += chunk.length;
+        bar.tick(chunk.length, { data: bytes(total) });
+    });
+}

package/dist/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../src/index.ts","../src/commands/slugs/download.ts","../src/commands/slugs/index.ts","../src/lib/download.ts"],"version":"5.7.3"}

package/oclif.manifest.json

@@ -0,0 +1,100 @@
+{
+  "commands": {
+    "slugs:download": {
+      "aliases": [],
+      "args": {
+        "slug": {
+          "description": "name or ID of slug",
+          "name": "slug"
+        }
+      },
+      "description": "download a slug's tarball to <APP_NAME>/slug.tar.gz and then extract the slug",
+      "examples": [
+        "$ heroku slugs:download --app example-app v2",
+        "$ heroku slugs:download --app example-app v2 --no-extract-slug"
+      ],
+      "flags": {
+        "app": {
+          "char": "a",
+          "description": "app to run command against",
+          "name": "app",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "no-extract-slug": {
+          "char": "e",
+          "description": "skip extracting slug after download",
+          "name": "no-extract-slug",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "remote": {
+          "char": "r",
+          "description": "git remote of app to use",
+          "name": "remote",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "slugs:download",
+      "pluginAlias": "@heroku-cli/heroku-slugs",
+      "pluginName": "@heroku-cli/heroku-slugs",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "slugs",
+        "download.js"
+      ]
+    },
+    "slugs": {
+      "aliases": [],
+      "args": {},
+      "description": "list recent slugs on application",
+      "examples": [
+        "$ heroku slugs --app myapp"
+      ],
+      "flags": {
+        "app": {
+          "char": "a",
+          "description": "app to run command against",
+          "name": "app",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "remote": {
+          "char": "r",
+          "description": "git remote of app to use",
+          "name": "remote",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "slugs",
+      "pluginAlias": "@heroku-cli/heroku-slugs",
+      "pluginName": "@heroku-cli/heroku-slugs",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "slugs",
+        "index.js"
+      ]
+    }
+  },
+  "version": "2.0.0"
+}

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@heroku-cli/heroku-slugs",
+  "description": "Heroku CLI Plugin to manage and download slugs",
+  "version": "2.0.0",
+  "author": "Heroku",
+  "bugs": {
+    "url": "https://github.com/heroku/heroku-slugs/issues"
+  },
+  "dependencies": {
+    "@heroku-cli/color": "2.0.4",
+    "@heroku-cli/command": "^11.5.0",
+    "@heroku-cli/notifications": "1.2.5",
+    "@oclif/core": "^2.16.0",
+    "bytes": "^3.1.2",
+    "fs-extra": "^11.3.0",
+    "smooth-progress": "^1.1.0"
+  },
+  "devDependencies": {
+    "@heroku-cli/schema": "^2.0.0",
+    "@oclif/plugin-help": "^5",
+    "@types/bytes": "^3.1.4",
+    "@types/chai": "^4",
+    "@types/fs-extra": "^11.0.4",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "20.14.8",
+    "@types/sinon": "^17.0.3",
+    "@types/supports-color": "^8.1.3",
+    "chai": "^4.4.1",
+    "eslint": "^8.57.0",
+    "eslint-config-oclif": "^5.2.2",
+    "eslint-config-oclif-typescript": "^3.1.14",
+    "eslint-plugin-mocha": "^10.5.0",
+    "mocha": "^11.1.0",
+    "nock": "^14.0.0",
+    "nyc": "^17.1.0",
+    "oclif": "4.14.36",
+    "sinon": "^19.0.2",
+    "stdout-stderr": "0.1.13",
+    "strip-ansi": "^6.0.1",
+    "ts-node": "^10.9.2",
+    "tsheredoc": "^1.0.1",
+    "typescript": "^5.7.3"
+  },
+  "engines": {
+    "node": ">= 20"
+  },
+  "files": [
+    "/dist",
+    "/oclif.manifest.json"
+  ],
+  "keywords": [
+    "heroku-plugin",
+    "oclif"
+  ],
+  "license": "ISC",
+  "main": "dist/index.js",
+  "mocha": {
+    "require": [
+      "test/init.js",
+      "ts-node/register"
+    ],
+    "watch-extensions": "ts",
+    "recursive": true,
+    "reporter": "spec",
+    "timeout": 360000
+  },
+  "types": "dist/index.d.ts",
+  "oclif": {
+    "commands": "./dist/commands",
+    "bin": "heroku",
+    "topics": {
+      "slugs": {
+        "description": "manage and download slugs"
+      }
+    }
+  },
+  "repository": "heroku/heroku-slugs",
+  "scripts": {
+    "build": "rm -rf dist && tsc -b",
+    "lint": "eslint . --ext .ts --config .eslintrc",
+    "postpack": "rm -f oclif.manifest.json",
+    "prepack": "yarn build && oclif manifest && oclif readme",
+    "test": "nyc mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md"
+  }
+}