{"id":25836032,"url":"https://github.com/bugsplat-git/node-minidump-stackwalk","last_synced_at":"2026-02-02T09:46:12.707Z","repository":{"id":166971646,"uuid":"642482706","full_name":"BugSplat-Git/node-minidump-stackwalk","owner":"BugSplat-Git","description":"Node.js wrapper for calling Breakpad's minidump-stackwalk","archived":false,"fork":false,"pushed_at":"2024-11-27T00:32:44.000Z","size":10577,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-02-28T22:16:12.522Z","etag":null,"topics":["breakpad","crash-reporting","crashpad","minidump","minidumpstackwalk"],"latest_commit_sha":null,"homepage":"https://bugsplat.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BugSplat-Git.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-18T17:05:41.000Z","updated_at":"2024-11-27T00:32:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"4071cd78-baf6-4725-9607-a5050fb1e40c","html_url":"https://github.com/BugSplat-Git/node-minidump-stackwalk","commit_stats":null,"previous_names":["bugsplat-git/node-minidump-stackwalk"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BugSplat-Git%2Fnode-minidump-stackwalk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BugSplat-Git%2Fnode-minidump-stackwalk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BugSplat-Git%2Fnode-minidump-stackwalk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BugSplat-Git%2Fnode-minidump-stackwalk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BugSplat-Git","download_url":"https://codeload.github.com/BugSplat-Git/node-minidump-stackwalk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241304302,"owners_count":19941100,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["breakpad","crash-reporting","crashpad","minidump","minidumpstackwalk"],"created_at":"2025-03-01T01:38:55.931Z","updated_at":"2026-02-02T09:46:07.688Z","avatar_url":"https://github.com/BugSplat-Git.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![bugsplat-github-banner-basic-outline](https://user-images.githubusercontent.com/20464226/149019306-3186103c-5315-4dad-a499-4fd1df408475.png)](https://bugsplat.com)\n\u003cbr/\u003e\n# \u003cdiv align=\"center\"\u003eBugSplat\u003c/div\u003e \n### **\u003cdiv align=\"center\"\u003eCrash and error reporting built for busy developers.\u003c/div\u003e**\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://twitter.com/BugSplatCo\"\u003e\n        \u003cimg alt=\"Follow @bugsplatco on Twitter\" src=\"https://img.shields.io/twitter/follow/bugsplatco?label=Follow%20BugSplat\u0026style=social\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://discord.gg/K4KjjRV5ve\"\u003e\n        \u003cimg alt=\"Join BugSplat on Discord\" src=\"https://img.shields.io/discord/664965194799251487?label=Join%20Discord\u0026logo=Discord\u0026style=social\"\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\n## 👋 Introduction\n\nnode-minidump-stackwalk is a thin wrapper around the [Breakpad](https://chromium.googlesource.com/breakpad/breakpad/) minidump_stackwalk utility that allows minidump_stackwalk to be added to your project via [npm](https://www.npmjs.com/). This package can be invoked via the `node-minidump-stackwalk` command-line command, or used as a library by importing `minidumpStackwalk`.\n\n## 🏗️ Installation\n\nInstall `node-minidump-stackwalk` as a package dependency.\n\n```sh\nnpm i node-minidump-stackwalk\n```\n\nOr install `node-minidump-stackwalk` globally as a command-line tool.\n\n```sh\nnpm i -g node-minidump-stackwalk\n```\n\n## 🧑‍💻 Command\n\nIf you installed `node-minidump-stackwalk` globally you can invoke it in via a terminal window.\n\n```sh\nnode-minidump-stackwalk \u003cminidump-file-path\u003e \u003csymbol-paths\u003e [-p \u003cplatform\u003e] [-m] [-s] [-c] [-b] [-v]\n```\n\nThe first argument is the path to your minidump file. The second argument is a path or array of paths to search for sym files. Specify a platform with `-p \u003cplatform\u003e`. Valid platforms are `darwin`, and `bullseye`. You can also specify the `-m`, `-s`, `-c`, and `-b` minidump_stackwalk arguments. The `-v` argument will print stderr to the terminal.\n\nFor additional platform support, please [open an issue](https://github.com/BugSplat-Git/node-minidump-stackwalk/issues/new).\n\n## 📚 Library\n\nImport or require `minidumpStackwalk`.\n\n```ts\nimport { minidumpStackwalk, minidumpStackwalkSync } from 'node-minidump-stackwalk'\n```\n\nAwait a call to `minidumpStackwalk`, providing it a path to your minidump file, and an array of symbol folder paths, and optionally the platform you're running on as well as options to forward to the minidump_stackwalk executable.\n\n```ts\nconst options: MinidumpStackwalkOptions = {\n  machineReadable: true,\n  stackContents: false,\n  dumpingThreadOnly: false,\n  threadBrief: falst\n};\n\nawait minidumpStackwalk('/path/to/minidump.dmp', ['/path/to/symbols'], 'darwin', options);\n```\n\nYou can also call `minidumpStackwalkSync` to perform the same operation synchronously.\n\n```ts\nminidumpStackwalkSync('/path/to/minidump.dmp', ['/path/to/symbols'], 'darwin', options);\n```\n\n## 🐛 About\n\n[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.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbugsplat-git%2Fnode-minidump-stackwalk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbugsplat-git%2Fnode-minidump-stackwalk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbugsplat-git%2Fnode-minidump-stackwalk/lists"}