@bugsnag/cli

CLI

Simplify the process of creating releases on the BugSnag dashboard and uploading files to improve the stacktraces in your errors with our command line tool.

Installation

The binaries are available on our GitHub releases page for macOS, Linux and Windows.

cURL / Wget

To install or upgrade to the latest binary for your architecture, you can also run the following cURL or Wget commands:

curl -o- https://raw.githubusercontent.com/bugsnag/bugsnag-cli/main/install.sh | bash

wget -qO- https://raw.githubusercontent.com/bugsnag/bugsnag-cli/main/install.sh | bash

The script downloads the appropriate binary and attempts to install it to ~/.local/bugsnag.

NPM

If your project uses npm or yarn, the CLI can be installed by adding the @bugsnag/cli package:

npm install @bugsnag/cli`

It can then be executed from your project scripts at /node_modules/.bin/bugsnag-cli or using npx @bugsnag/cli.

Supported commands

Create builds

Allows you to create a build within BugSnag to enrich releases shown in the BugSnag dashboard.

$ bugsnag-cli create-build --api-key=YOUR_API_KEY --app-version=YOUR_APP_VERSION

See the create-build command reference for full usage information.

Symbol & mapping file uploads

Simplifies the upload of the various symbol and mapping files required to make your stacktraces readable in the BugSnag dashboard. Where possible files the files to upload are located automatically and the parameters, such as API key, located in project files. However all options can be overridden to allow you to customize the command for your build system.

Supported uploads with links to online docs for the file type:

• Android (obfuscation mapping and native symbol files, from builds or AAB files)
• iOS (.dSYM from builds or archives)
• JavaScript source maps – for web and React Native
• Unity (Android symbols)
• Dart (stripped symbols)
• Breakpad (generated symbol files)

BugSnag On-Premise

If you are using BugSnag On-premise, you should use the --build-api-root-url and --upload-api-root-url options to set the URL of your build and upload servers, for example:

bugsnag-cli upload \
  --upload-api-root-url https://bugsnag.my-company.com/
  # ... other options

Support

• Check out the documentation
• Search open and closed issues for similar problems
• Report a bug or request a feature

Contributing

Most updates to this repo will be made by Bugsnag employees. We are unable to accommodate significant external PRs such as features additions or any large refactoring, however minor fixes are welcome. See contributing for more information.

License

This package is free software released under the MIT License. See license for details.