https://github.com/bugsplat-git/node-dump-syms
npm package for running dump_syms
https://github.com/bugsplat-git/node-dump-syms
breakpad crashpad minidump symbols
Last synced: 10 months ago
JSON representation
npm package for running dump_syms
- Host: GitHub
- URL: https://github.com/bugsplat-git/node-dump-syms
- Owner: BugSplat-Git
- License: mit
- Created: 2022-12-22T18:56:14.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T21:25:20.000Z (over 1 year ago)
- Last Synced: 2024-10-11T02:36:54.830Z (about 1 year ago)
- Topics: breakpad, crashpad, minidump, symbols
- Language: Rust
- Homepage: https://bugsplat.com
- Size: 13.8 MB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://bugsplat.com)
#
BugSplat
### **Crash and error reporting built for busy developers.**
## 👋 Introduction
node-dump-syms is a thin wrapper around the Mozilla [dump_syms](https://crates.io/crates/dump_syms) crate that allows dump_syms to be added to your project via [npm](https://www.npmjs.com/). This package can be invoked via the `node-dump-syms` command-line command, or used as a library by importing `dumpSyms`.
## ✅ Prerequisites
This repo provides prebuilt native addons for node.js 18.x and 20.x on Windows, macOS, and Ubuntu Linux. If you are using a different version of Node.js or a different OS, you will need to build the native addon from source which requires the [rust](https://www.rust-lang.org/tools/install) toolchain. Once you have installed rust, you can build the native addon from source by re-running `npm i`.
If you would like to request a prebuilt binary for a different version of Node.js or a different OS, please open an [issue](https://github.com/BugSplat-Git/node-dump-syms/issues).
## 🏗️ Installation
Install `node-dump-syms` as a package dependency.
```sh
npm i node-dump-syms
```
Or install `node-dump-syms` globally as a command-line tool.
```sh
npm i -g node-dump-syms
```
## 🧑💻 Command
If you installed `node-dump-syms` globally you can invoke it in via a terminal window.
```sh
node-dump-syms /path/to/file.so /output/file.so.sym
```
The first argument is the path to your binary file. The second argument is the path to write the output sym file.
## 📚 Library
Import or require `dumpSyms`.
```ts
import { dumpSyms } from 'node-dump-syms'
```
Call `dumpSyms`, providing it a path to your binary file, an output path for the `.sym` file.
```ts
dumpSyms('/path/to/file.so', '/output/file.so.sym');
```
## 🐛 About
[BugSplat](https://bugsplat.com) is a software crash and error reporting service with support for [Qt](https://docs.bugsplat.com/introduction/getting-started/integrations/cross-platform/qt), [Linux](https://docs.bugsplat.com/introduction/getting-started/integrations/desktop/linux), [Android](https://docs.bugsplat.com/introduction/getting-started/integrations/mobile/android) and [many more](https://docs.bugsplat.com/introduction/getting-started/integrations). BugSplat automatically captures critical diagnostic data such as stack traces, log files, and other runtime information. BugSplat also provides automated incident notifications, a convenient dashboard for monitoring trends and prioritizing engineering efforts, and integrations with popular development tools to maximize productivity and ship more profitable software.