@sentry/cli
Version:
A command line utility to work with Sentry. https://docs.sentry.io/hosted/learn/cli/
72 lines (71 loc) • 2.71 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.SentryCli = void 0;
const pkgInfo = require("../package.json");
const helper = require("./helper");
const releases_1 = require("./releases");
const sourceMaps_1 = require("./sourceMaps");
/**
* Interface to and wrapper around the `sentry-cli` executable.
*
* Commands are grouped into namespaces. See the respective namespaces for more
* documentation. To use this wrapper, simply create an instance and call methods:
*
* @example
* const cli = new SentryCli();
* console.log(SentryCli.getVersion());
*
* @example
* const cli = new SentryCli('path/to/custom/sentry.properties');
* const release = await cli.releases.proposeVersion());
* console.log(release);
*/
class SentryCli {
/**
* Creates a new `SentryCli` instance.
*
* If the `configFile` parameter is specified, configuration located in the default
* location and the value specified in the `SENTRY_PROPERTIES` environment variable is
* overridden.
*
* @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 options More options to pass to the CLI
*/
constructor(configFile, options) {
this.configFile = configFile;
this.options = options;
if (typeof configFile === 'string') {
this.configFile = configFile;
}
this.options = options || { silent: false };
this.releases = new releases_1.Releases(this.options, configFile);
this.sourceMaps = new sourceMaps_1.SourceMaps(this.options, configFile);
}
/**
* Returns the version of the installed `sentry-cli` binary.
*/
static getVersion() {
return pkgInfo.version;
}
/**
* Returns an absolute path to the `sentry-cli` binary.
*/
static getPath() {
return helper.getPath();
}
/**
* See {helper.execute} docs.
* @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.
* - `false` to not inherit stdio and return the output as a string.
* @returns A promise that resolves to the standard output.
*/
execute(args, live) {
return helper.execute(args, live, this.options.silent, this.configFile, this.options);
}
}
exports.SentryCli = SentryCli;