@sentry/cli 2.58.3 → 3.0.0

package/README.md

@@ -8,127 +8,36 @@
   </a>
 </p>
 
-# Official Sentry Command Line Interface
+# Sentry CLI
 
-[![Build Status](https://github.com/getsentry/sentry-cli/workflows/CI/badge.svg?branch=master)](https://github.com/getsentry/sentry-cli/actions?query=workflow%3ACI)
-[![GitHub release](https://img.shields.io/github/release/getsentry/sentry-cli.svg)](https://github.com/getsentry/sentry-cli/releases/latest)
-[![npm version](https://img.shields.io/npm/v/@sentry/cli.svg)](https://www.npmjs.com/package/@sentry/cli)
-[![license](https://img.shields.io/github/license/getsentry/sentry-cli.svg)](https://github.com/getsentry/sentry-cli/blob/master/LICENSE)
+This is the repository for Sentry CLI, the official command line interface for Sentry.
 
-This is a Sentry command line client for some generic tasks. Right now this is
-primarily used to upload debug symbols to Sentry if you are not using the
-Fastlane tools.
+Sentry CLI can be used for many tasks, including uploading debug symbols and source maps to Sentry, managing releases, and viewing Sentry data such as issues and logs.
 
-* Downloads can be found under
-  [Releases](https://github.com/getsentry/sentry-cli/releases/)
-* Documentation can be found [here](https://docs.sentry.io/hosted/learn/cli/)
+## Installation and Usage
 
-## Installation
+Please refer to [Sentry CLI's documentation page](https://docs.sentry.io/cli/).
 
-If you are on macOS or Linux, you can use the automated downloader which will fetch the latest release version for you and install it:
+## Compatibility
 
-    curl -sL https://sentry.io/get-cli/ | bash
+Sentry CLI officially supports [Sentry SaaS](https://sentry.io/) and [Sentry Self-Hosted](https://github.com/getsentry/self-hosted) versions 25.11.1 and above.
 
-We do, however, encourage you to pin the specific version of the CLI, so your builds are always reproducible.
-To do that, you can use the exact same method, with an additional version specifier:
+### Self-Hosted Sentry
 
-    curl -sL https://sentry.io/get-cli/ | SENTRY_CLI_VERSION=2.33.1 bash
+Although some Sentry CLI features may work with versions of Sentry Self-Hosted prior to 25.11.1, we recommend users upgrade their self-hosted installations to a compatible version.
 
-This will automatically download the correct version of `sentry-cli` for your operating system and install it. If necessary, it will prompt for your admin password for `sudo`. For a different installation location or for systems without `sudo` (like Windows), you can `export INSTALL_DIR=/custom/installation/path` before running this command.
+For users who cannot upgrade their self-hosted installation, we recommend using the latest compatible Sentry CLI version, per the table below:
 
-If you are using `sentry-cli` on Windows environments, [Microsoft Visual C++ Redistributable](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist) is required.
+| **Sentry Self-Hosted Version** | **Newest Compatible Sentry CLI Version**                              |
+| ------------------------------ | --------------------------------------------------------------------- |
+| ≥ 25.11.1                      | [latest](https://github.com/getsentry/sentry-cli/releases/latest)     |
+| < 25.11.1                      | [2.58.4](https://github.com/getsentry/sentry-cli/releases/tag/2.58.4) |
 
-To verify it’s installed correctly you can bring up the help:
+Note that we can only provide support for officially-supported Sentry Self-Hosted versions. We will not backport fixes for older Sentry CLI versions, even if they should be compatible with your self-hosted version.
 
-    sentry-cli --help
+## Versioning
 
-### pip
-
-_New in 2.14.3_: `sentry-cli` can also be installed using `pip`:
-
-```bash
-pip install sentry-cli
-```
-
-### Node
-
-Additionally, you can also install this binary via npm:
-
-    npm install @sentry/cli
-
-When installing globally, make sure to have set
-[correct permissions on the global node_modules directory](https://docs.npmjs.com/getting-started/fixing-npm-permissions).
-If this is not possible in your environment or still produces an EACCESS error,
-install as root:
-
-    sudo npm install -g @sentry/cli --unsafe-perm
-
-By default, this package will download sentry-cli from the CDN managed by [Fastly](https://www.fastly.com/).
-To use a custom CDN, set the npm config property `sentrycli_cdnurl`. The downloader will append
-`"/<version>/sentry-cli-<dist>"`.
-
-```sh
-npm install @sentry/cli --sentrycli_cdnurl=https://mymirror.local/path
-```
-
-Or add property into your `.npmrc` file (https://www.npmjs.org/doc/files/npmrc.html)
-
-```rc
-sentrycli_cdnurl=https://mymirror.local/path
-```
-
-There are a few environment variables that you can provide to control the npm installation:
-
-```
-SENTRYCLI_CDNURL=<url> # Use alternative cdn url for downloading binary
-SENTRYCLI_USE_LOCAL=1 # Use local instance of sentry-cli binary (looked up via $PATH environment)
-SENTRYCLI_SKIP_DOWNLOAD=1 # Skip downloading binary entirely
-SENTRYCLI_NO_PROGRESS_BAR=1 # Do not print the progress bar when downloading binary (default for non-TTY environments like CI)
-SENTRYCLI_LOG_STREAM=<stdout|stderr> # Changes where to redirect install script output
-```
-
-When using `sentry-cli` via JavaScript API or any 3rd party plugin that is consuming said API,
-you can also use `SENTRY_BINARY_PATH=<path>` alongside `SENTRYCLI_SKIP_DOWNLOAD=1` to completely
-control what binaries are downloaded and used throughout the whole process.
-
-If you're installing the CLI with NPM from behind a proxy, the install script will
-use either NPM's configured HTTPS proxy server or the value from your `HTTPS_PROXY`
-environment variable.
-
-### Homebrew
-
-A homebrew recipe is provided in the `getsentry/tools` tap:
-
-    brew install getsentry/tools/sentry-cli
-
-### Docker
-
-As of version _1.25.0_, there is an official Docker image that comes with
-`sentry-cli` preinstalled. If you prefer a specific version, specify it as tag.
-The latest development version is published under the `edge` tag. In production,
-we recommend you to use the `latest` tag. To use it, run:
-
-```sh
-docker pull getsentry/sentry-cli
-docker run --rm -v $(pwd):/work getsentry/sentry-cli --help
-```
-
-Starting version _`2.8.0`_, in case you see `"error: config value 'safe.directory' was not found;"` message,
-you also need to correctly set UID and GID of mounted volumes like so:
-
-```sh
-docker run --rm -u "$(id -u):$(id -g)" -v $(pwd):/work getsentry/sentry-cli --help
-```
-
-This is required due to security issue in older `git` implementations. See [here](https://github.blog/2022-04-12-git-security-vulnerability-announced/) for more details.
-
-## Update
-
-To update sentry-cli to the latest version run:
-
-```sh
-sentry-cli update
-```
+Sentry CLI follows semantic versioning, according to [this versioning policy](VERSIONING.md).
 
 ## Compiling
 

package/bin/sentry-cli

@@ -3,7 +3,7 @@
 'use strict';
 
 const childProcess = require('child_process');
-const SentryCli = require('../js');
+const { SentryCli } = require('../js');
 
 const child = childProcess
   .spawn(SentryCli.getPath(), process.argv.slice(2), {

package/checksums.txt

@@ -1,7 +1,10 @@
-sentry-cli-Linux-aarch64=30f95cf10ff96bdbbfdc1a25a7b65ee0a7f906f2c380c0cdde185d14d5535246
-sentry-cli-Linux-armv7=ae2c0ecee950055b388817bdb6dd543730c36d6def8794252c00314c3f0a7e18
-sentry-cli-Linux-i686=4a36158a3140a26e1e8fbbb72f80a836df3f49ebcb5787e05b360e0f9ee01b3c
-sentry-cli-Linux-x86_64=645e64af49e68a285b66d7ddf440d06b76f8a5603797060f61c0c487ac7e2a89
-sentry-cli-Windows-aarch64.exe=ae190527ff55ed70c028d033408f446fa99c87b9fabe0ea7b1a336851940b77a
-sentry-cli-Windows-i686.exe=024a72a8ff6e076cd500c17086a7a146dfb59e9469936eb16b8a1ba31cf7394a
-sentry-cli-Windows-x86_64.exe=e26c363d45c572c6ae133a913657f995d171f7179aa221371da81966b0d5d2ef
+sentry-cli-Darwin-arm64=3ef5233083cf2c6f37b3850bf6f970ef1770fb55d4911a1c36e53d0a540956f5
+sentry-cli-Darwin-universal=b2eb3f411eef8082037fd3cd1e561178a9f084028820d74619195e10cfc5e4e8
+sentry-cli-Darwin-x86_64=627ee375b823459d31c1b3f84fed5a700d299cb34c699608379e57a43e8a7a3c
+sentry-cli-Linux-aarch64=815686a698e60e41a34035a00a0f11194db266e4b92259b979254a51eaf7bc12
+sentry-cli-Linux-armv7=b9c2de7bb303e304a046876cf82f7cc1f2c2a68353cdcae4ffa38b80004e5607
+sentry-cli-Linux-i686=74f9c694a165fe3884dcafd04a7f0e686c93cd0d999ec55d58ce363bd97abe93
+sentry-cli-Linux-x86_64=460d2053f273fdbd26d88ccb35965448447c4b3715ddc8c6b476a3d243e54430
+sentry-cli-Windows-aarch64.exe=cbacd717d2980ca0bb5edecff369f168ecc8bd934f4cd9dd628a9973f6b92555
+sentry-cli-Windows-i686.exe=e3dde3c0b24a3b2ab37f75846b7e89e8698c53db08bbdc73f7b37860e285afca
+sentry-cli-Windows-x86_64.exe=4acb63ef42e59f9e1aee920e0b399d1781a91f8f25b666b75313a4444ca6a3dc

package/js/helper.d.ts

@@ -1,30 +1,60 @@
+import { SentryCliOptions } from './types';
 /**
- * The javascript type of a command line option.
+ * This convoluted function resolves the path to the manually downloaded fallback
+ * `sentry-cli` binary in a way that can't be analysed by @vercel/nft.
+ *
+ * Without this, the binary can be detected as an asset and included by bundlers
+ * that use @vercel/nft.
+ *
+ * @returns The path to the sentry-cli binary
+ */
+declare function getFallbackBinaryPath(): string;
+declare function getDistributionForThisPlatform(): {
+    packageName: any;
+    subpath: any;
+};
+/**
+ * Throws an error with a message stating that Sentry CLI doesn't support the current platform.
+ *
+ * @returns nothing. It throws.
  */
-export type OptionType = "array" | "string" | "boolean" | "inverted-boolean";
+declare function throwUnsupportedPlatformError(): void;
 /**
- * Schema definition of a command line option.
+ * Overrides the default binary path with a mock value, useful for testing.
+ *
+ * @param mockPath The new path to the mock sentry-cli binary
+ * @deprecated This was used in tests internally and will be removed in the next major version.
  */
-export type OptionSchema = {
-    /**
-     * The flag of the command line option including dashes.
-     */
+declare function mockBinaryPath(mockPath: string): void;
+export type OptionsSchema = Record<string, {
     param: string;
-    /**
-     * The value type of the command line option.
-     */
-    type: OptionType;
-    /**
-     * The flag of the command line option including dashes (optional).
-     */
+    type: 'array' | 'string' | 'number' | 'boolean' | 'inverted-boolean';
     invertedParam?: string;
-};
+} | {
+    param?: never;
+    type: 'array' | 'string' | 'number' | 'boolean' | 'inverted-boolean';
+    invertedParam: string;
+}>;
 /**
- * Schema definition for a command.
+ * Serializes command line options into an arguments array.
+ *
+ * @param schema An options schema required by the command.
+ * @param options An options object according to the schema.
  */
-export type OptionsSchema = {
-    [x: string]: OptionSchema;
-};
+declare function serializeOptions(schema: OptionsSchema, options: Record<string, unknown>): string[];
+/**
+ * Serializes the command and its options into an arguments array.
+ *
+ * @param command The literal name of the command.
+ * @param schema An options schema required by the command.
+ * @param options An options object according to the schema.
+ * @returns An arguments array that can be passed via command line.
+ */
+declare function prepareCommand(command: string[], schema: OptionsSchema, options: Record<string, unknown>): string[];
+/**
+ * Returns the absolute path to the `sentry-cli` binary.
+ */
+declare function getPath(): string;
 /**
  * Runs `sentry-cli` with the given command line arguments.
  *
@@ -42,82 +72,18 @@ export type OptionsSchema = {
  * const output = await execute(['--version']);
  * expect(output.trim()).toBe('sentry-cli x.y.z');
  *
- * @param {string[]} args Command line arguments passed to `sentry-cli`.
- * @param {boolean | 'rejectOnError'} live can be set to:
- *  - `true` to inherit stdio to display `sentry-cli` output directly.
- *  - `false` to not inherit stdio and return the output as a string.
- *  - `'rejectOnError'` to inherit stdio and reject the promise if the command
+ * @param args Command line arguments passed to `sentry-cli`.
+ * @param live can be set to:
+ *  - `true` to inherit stdio and reject the promise if the command
  *    exits with a non-zero exit code.
- * @param {boolean} silent Disable stdout for silents build (CI/Webpack Stats, ...)
- * @param {string} [configFile] Relative or absolute path to the configuration file.
- * @param {import('./index').SentryCliOptions} [config] More configuration to pass to the CLI
- * @returns {Promise<string>} A promise that resolves to the standard output.
- */
-export function execute(args: string[], live: boolean | "rejectOnError", silent: boolean, configFile?: string, config?: import("./index").SentryCliOptions): Promise<string>;
-/**
- * Returns the absolute path to the `sentry-cli` binary.
- * @returns {string}
+ *  - `false` to not inherit stdio and return the output as a string.
+ * @param silent Disable stdout for silents build (CI/Webpack Stats, ...)
+ * @param configFile Relative or absolute path to the configuration file.
+ * @param config More configuration to pass to the CLI
+ * @returns A promise that resolves to the standard output.
  */
-export function getPath(): string;
-export function getProjectFlagsFromOptions({ projects }?: {
+declare function execute(args: string[], live: boolean, silent: boolean, configFile: string | undefined, config?: SentryCliOptions): Promise<string>;
+declare function getProjectFlagsFromOptions({ projects }?: {
     projects?: any[];
 }): any;
-/**
- * Overrides the default binary path with a mock value, useful for testing.
- *
- * @param {string} mockPath The new path to the mock sentry-cli binary
- * @deprecated This was used in tests internally and will be removed in the next major version.
- */
-export function mockBinaryPath(mockPath: string): void;
-/**
- * Serializes the command and its options into an arguments array.
- *
- * @param {string[]} command The literal name of the command.
- * @param {OptionsSchema} [schema] An options schema required by the command.
- * @param {object} [options] An options object according to the schema.
- * @returns {string[]} An arguments array that can be passed via command line.
- */
-export function prepareCommand(command: string[], schema?: OptionsSchema, options?: object): string[];
-/**
- * The javascript type of a command line option.
- * @typedef {'array'|'string'|'boolean'|'inverted-boolean'} OptionType
- */
-/**
- * Schema definition of a command line option.
- * @typedef {object} OptionSchema
- * @prop {string} param The flag of the command line option including dashes.
- * @prop {OptionType} type The value type of the command line option.
- * @prop {string} [invertedParam] The flag of the command line option including dashes (optional).
- */
-/**
- * Schema definition for a command.
- * @typedef {Object.<string, OptionSchema>} OptionsSchema
- */
-/**
- * Serializes command line options into an arguments array.
- *
- * @param {OptionsSchema} schema An options schema required by the command.
- * @param {object} options An options object according to the schema.
- * @returns {string[]} An arguments array that can be passed via command line.
- */
-export function serializeOptions(schema: OptionsSchema, options: object): string[];
-export function getDistributionForThisPlatform(): {
-    packageName: string;
-    subpath: string;
-};
-/**
- * Throws an error with a message stating that Sentry CLI doesn't support the current platform.
- *
- * @returns {never} nothing. It throws.
- */
-export function throwUnsupportedPlatformError(): never;
-/**
- * This convoluted function resolves the path to the manually downloaded fallback
- * `sentry-cli` binary in a way that can't be analysed by @vercel/nft.
- *
- * Without this, the binary can be detected as an asset and included by bundlers
- * that use @vercel/nft.
- *
- * @returns {string} The path to the sentry-cli binary
- */
-export function getFallbackBinaryPath(): string;
+export { execute, getPath, getProjectFlagsFromOptions, mockBinaryPath, prepareCommand, serializeOptions, getDistributionForThisPlatform, throwUnsupportedPlatformError, getFallbackBinaryPath, };

package/js/helper.js

@@ -8,10 +8,20 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-const os = require('os');
-const path = require('path');
-const fs = require('fs');
-const childProcess = require('child_process');
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.execute = execute;
+exports.getPath = getPath;
+exports.getProjectFlagsFromOptions = getProjectFlagsFromOptions;
+exports.mockBinaryPath = mockBinaryPath;
+exports.prepareCommand = prepareCommand;
+exports.serializeOptions = serializeOptions;
+exports.getDistributionForThisPlatform = getDistributionForThisPlatform;
+exports.throwUnsupportedPlatformError = throwUnsupportedPlatformError;
+exports.getFallbackBinaryPath = getFallbackBinaryPath;
+const os = require("node:os");
+const path = require("node:path");
+const fs = require("node:fs");
+const childProcess = require("node:child_process");
 const BINARY_DISTRIBUTIONS = [
     { packageName: '@sentry/cli-darwin', subpath: 'bin/sentry-cli' },
     { packageName: '@sentry/cli-linux-x64', subpath: 'bin/sentry-cli' },
@@ -29,7 +39,7 @@ const BINARY_DISTRIBUTIONS = [
  * Without this, the binary can be detected as an asset and included by bundlers
  * that use @vercel/nft.
  *
- * @returns {string} The path to the sentry-cli binary
+ * @returns The path to the sentry-cli binary
  */
 function getFallbackBinaryPath() {
     const parts = [];
@@ -96,7 +106,7 @@ function getDistributionForThisPlatform() {
 /**
  * Throws an error with a message stating that Sentry CLI doesn't support the current platform.
  *
- * @returns {never} nothing. It throws.
+ * @returns nothing. It throws.
  */
 function throwUnsupportedPlatformError() {
     throw new Error(`Unsupported operating system or architecture! Sentry CLI does not work on this architecture.
@@ -110,7 +120,7 @@ Sentry CLI supports:
  * Tries to find the installed Sentry CLI binary - either by looking into the relevant
  * optional dependencies or by trying to resolve the fallback binary.
  *
- * @returns {string} The path to the sentry-cli binary
+ * @returns The path to the sentry-cli binary
  */
 function getBinaryPath() {
     if (process.env.SENTRY_BINARY_PATH) {
@@ -157,40 +167,23 @@ It seems like none of the "@sentry/cli" package's optional dependencies got inst
 }
 /**
  * Will be used as the binary path when defined with `mockBinaryPath`.
- * @type {string | undefined}
  */
 let mockedBinaryPath;
 /**
  * Overrides the default binary path with a mock value, useful for testing.
  *
- * @param {string} mockPath The new path to the mock sentry-cli binary
+ * @param mockPath The new path to the mock sentry-cli binary
  * @deprecated This was used in tests internally and will be removed in the next major version.
  */
 // TODO(v3): Remove this function
 function mockBinaryPath(mockPath) {
     mockedBinaryPath = mockPath;
 }
-/**
- * The javascript type of a command line option.
- * @typedef {'array'|'string'|'boolean'|'inverted-boolean'} OptionType
- */
-/**
- * Schema definition of a command line option.
- * @typedef {object} OptionSchema
- * @prop {string} param The flag of the command line option including dashes.
- * @prop {OptionType} type The value type of the command line option.
- * @prop {string} [invertedParam] The flag of the command line option including dashes (optional).
- */
-/**
- * Schema definition for a command.
- * @typedef {Object.<string, OptionSchema>} OptionsSchema
- */
 /**
  * Serializes command line options into an arguments array.
  *
- * @param {OptionsSchema} schema An options schema required by the command.
- * @param {object} options An options object according to the schema.
- * @returns {string[]} An arguments array that can be passed via command line.
+ * @param schema An options schema required by the command.
+ * @param options An options object according to the schema.
  */
 function serializeOptions(schema, options) {
     return Object.keys(schema).reduce((newOptions, option) => {
@@ -225,17 +218,16 @@ function serializeOptions(schema, options) {
 /**
  * Serializes the command and its options into an arguments array.
  *
- * @param {string[]} command The literal name of the command.
- * @param {OptionsSchema} [schema] An options schema required by the command.
- * @param {object} [options] An options object according to the schema.
- * @returns {string[]} An arguments array that can be passed via command line.
+ * @param command The literal name of the command.
+ * @param schema An options schema required by the command.
+ * @param options An options object according to the schema.
+ * @returns An arguments array that can be passed via command line.
  */
 function prepareCommand(command, schema, options) {
     return command.concat(serializeOptions(schema || {}, options || {}));
 }
 /**
  * Returns the absolute path to the `sentry-cli` binary.
- * @returns {string}
  */
 function getPath() {
     return mockedBinaryPath !== undefined ? mockedBinaryPath : getBinaryPath();
@@ -257,16 +249,15 @@ function getPath() {
  * const output = await execute(['--version']);
  * expect(output.trim()).toBe('sentry-cli x.y.z');
  *
- * @param {string[]} args Command line arguments passed to `sentry-cli`.
- * @param {boolean | 'rejectOnError'} live can be set to:
- *  - `true` to inherit stdio to display `sentry-cli` output directly.
- *  - `false` to not inherit stdio and return the output as a string.
- *  - `'rejectOnError'` to inherit stdio and reject the promise if the command
+ * @param args Command line arguments passed to `sentry-cli`.
+ * @param live can be set to:
+ *  - `true` to inherit stdio and reject the promise if the command
  *    exits with a non-zero exit code.
- * @param {boolean} silent Disable stdout for silents build (CI/Webpack Stats, ...)
- * @param {string} [configFile] Relative or absolute path to the configuration file.
- * @param {import('./index').SentryCliOptions} [config] More configuration to pass to the CLI
- * @returns {Promise<string>} A promise that resolves to the standard output.
+ *  - `false` to not inherit stdio and return the output as a string.
+ * @param silent Disable stdout for silents build (CI/Webpack Stats, ...)
+ * @param configFile Relative or absolute path to the configuration file.
+ * @param config More configuration to pass to the CLI
+ * @returns A promise that resolves to the standard output.
  */
 function execute(args_1, live_1, silent_1, configFile_1) {
     return __awaiter(this, arguments, void 0, function* (args, live, silent, configFile, config = {}) {
@@ -280,9 +271,6 @@ function execute(args_1, live_1, silent_1, configFile_1) {
         if (config.authToken) {
             env.SENTRY_AUTH_TOKEN = config.authToken;
         }
-        if (config.apiKey) {
-            env.SENTRY_API_KEY = config.apiKey;
-        }
         if (config.dsn) {
             env.SENTRY_DSN = config.dsn;
         }
@@ -306,7 +294,7 @@ function execute(args_1, live_1, silent_1, configFile_1) {
             args = [...headers, ...args];
         }
         return new Promise((resolve, reject) => {
-            if (live === true || live === 'rejectOnError') {
+            if (live) {
                 const output = silent ? 'ignore' : 'inherit';
                 const pid = childProcess.spawn(getPath(), args, {
                     env,
@@ -314,18 +302,10 @@ function execute(args_1, live_1, silent_1, configFile_1) {
                     stdio: ['ignore', output, output],
                 });
                 pid.on('exit', (exitCode) => {
-                    if (live === 'rejectOnError') {
-                        if (exitCode === 0) {
-                            resolve('success (live mode)');
-                        }
-                        reject(new Error(`Command ${args.join(' ')} failed with exit code ${exitCode}`));
+                    if (exitCode === 0) {
+                        resolve('success (live mode)');
                     }
-                    // According to the type definition, resolving with void is not allowed.
-                    // However, for backwards compatibility, we resolve void here to
-                    // avoid a behaviour-breaking change.
-                    // TODO (v3): Clean this up and always resolve a string (or change the type definition)
-                    // @ts-expect-error - see comment above
-                    resolve();
+                    reject(new Error(`Command ${args.join(' ')} failed with exit code ${exitCode}`));
                 });
             }
             else {
@@ -344,14 +324,3 @@ function execute(args_1, live_1, silent_1, configFile_1) {
 function getProjectFlagsFromOptions({ projects = [] } = {}) {
     return projects.reduce((flags, project) => flags.concat('-p', project), []);
 }
-module.exports = {
-    execute,
-    getPath,
-    getProjectFlagsFromOptions,
-    mockBinaryPath,
-    prepareCommand,
-    serializeOptions,
-    getDistributionForThisPlatform,
-    throwUnsupportedPlatformError,
-    getFallbackBinaryPath,
-};

package/js/index.d.ts

@@ -1,12 +1,6 @@
-export = SentryCli;
-/**
- * @typedef {import('./types').SentryCliOptions} SentryCliOptions
- * @typedef {import('./types').SentryCliUploadSourceMapsOptions} SentryCliUploadSourceMapsOptions
- * @typedef {import('./types').SourceMapsPathDescriptor} SourceMapsPathDescriptor
- * @typedef {import('./types').SentryCliNewDeployOptions} SentryCliNewDeployOptions
- * @typedef {import('./types').SentryCliCommitsOptions} SentryCliCommitsOptions
- * @typedef {import('./types').SentryCliReleases} SentryCliReleases
- */
+import { Releases } from './releases';
+import type { SentryCliOptions } from './types';
+export type { SentryCliOptions, SentryCliUploadSourceMapsOptions, SourceMapsPathDescriptor, SentryCliNewDeployOptions, SentryCliCommitsOptions, } from './types';
 /**
  * Interface to and wrapper around the `sentry-cli` executable.
  *
@@ -22,17 +16,10 @@ export = SentryCli;
  * const release = await cli.releases.proposeVersion());
  * console.log(release);
  */
-declare class SentryCli {
-    /**
-     * Returns the version of the installed `sentry-cli` binary.
-     * @returns {string}
-     */
-    static getVersion(): string;
-    /**
-     * Returns an absolute path to the `sentry-cli` binary.
-     * @returns {string}
-     */
-    static getPath(): string;
+export declare class SentryCli {
+    configFile: string | null;
+    options: SentryCliOptions;
+    releases: Releases;
     /**
      * Creates a new `SentryCli` instance.
      *
@@ -40,34 +27,28 @@ declare class SentryCli {
      * location and the value specified in the `SENTRY_PROPERTIES` environment variable is
      * overridden.
      *
-     * @param {string | null} [configFile] - Path to Sentry CLI config properties, as described in https://docs.sentry.io/learn/cli/configuration/#properties-files.
+     * @param configFile Path to Sentry CLI config properties, as described in https://docs.sentry.io/learn/cli/configuration/#properties-files.
      * By default, the config file is looked for upwards from the current path and defaults from ~/.sentryclirc are always loaded.
      * This value will update `SENTRY_PROPERTIES` env variable.
-     * @param {SentryCliOptions} [options] - More options to pass to the CLI
+     * @param options More options to pass to the CLI
      */
-    constructor(configFile?: string | null, options?: SentryCliOptions);
-    configFile: string;
-    options: import("./types").SentryCliOptions;
-    releases: Releases;
+    constructor(configFile: string | null, options: SentryCliOptions);
+    /**
+     * Returns the version of the installed `sentry-cli` binary.
+     */
+    static getVersion(): string;
+    /**
+     * Returns an absolute path to the `sentry-cli` binary.
+     */
+    static getPath(): string;
     /**
      * See {helper.execute} docs.
-     * @param {string[]} args Command line arguments passed to `sentry-cli`.
-     * @param {boolean | 'rejectOnError'} live can be set to:
-     *  - `true` to inherit stdio to display `sentry-cli` output directly.
-     *  - `false` to not inherit stdio and return the output as a string.
-     *  - `'rejectOnError'` to inherit stdio and reject the promise if the command
+     * @param args Command line arguments passed to `sentry-cli`.
+     * @param live can be set to:
+     *  - `true` to inherit stdio and reject the promise if the command
      *    exits with a non-zero exit code.
-     * @returns {Promise<string>} A promise that resolves to the standard output.
+     *  - `false` to not inherit stdio and return the output as a string.
+     * @returns A promise that resolves to the standard output.
      */
-    execute(args: string[], live: boolean | "rejectOnError"): Promise<string>;
-}
-declare namespace SentryCli {
-    export { SentryCliOptions, SentryCliUploadSourceMapsOptions, SourceMapsPathDescriptor, SentryCliNewDeployOptions, SentryCliCommitsOptions, SentryCliReleases };
+    execute(args: string[], live: boolean): Promise<string>;
 }
-import Releases = require("./releases");
-type SentryCliOptions = import("./types").SentryCliOptions;
-type SentryCliUploadSourceMapsOptions = import("./types").SentryCliUploadSourceMapsOptions;
-type SourceMapsPathDescriptor = import("./types").SourceMapsPathDescriptor;
-type SentryCliNewDeployOptions = import("./types").SentryCliNewDeployOptions;
-type SentryCliCommitsOptions = import("./types").SentryCliCommitsOptions;
-type SentryCliReleases = import("./types").SentryCliReleases;