symbolic

(★ 546)

Stack trace symbolication library written in Rust

File Explorer

Download Latest Version (.zip)

- - build.yml
  - ci.yml
  - danger.yml
  - enforce-license-compliance.yml
  - release.yml
  - weekly.yml
- CODEOWNERS
- c_cpp_properties.json
- extensions.json
- launch.json
- settings.json
- tasks.json
- - Cargo.toml
- - Cargo.toml
- - Cargo.toml
- - Cargo.toml
- - Cargo.toml
- - Cargo.toml
- - Cargo.toml
- - Cargo.toml
- - Cargo.toml
- - __init__.py
  - _lowlevel.pyi
  - cfi.py
  - common.py
  - debuginfo.py
  - exceptions.py
  - proguard.py
  - py.typed
  - sourcemap.py
  - sourcemapcache.py
  - symcache.py
  - utils.py
- - conftest.py
  - test_cfi.py
  - test_common.py
  - test_crashprobe.py
  - test_debug.py
  - test_heuristics.py
  - test_proguard.py
  - test_sourcemaps.py
  - test_symcache.py
- .flake8
- .gitignore
- MANIFEST.in
- manylinux.sh
- manylinux_aarch64.sh
- README
- setup.cfg
- setup.py
- bump-version
- git-archive-all
- - lib.rs
- Cargo.toml
- README.md
- - common.c
  - object.c
- - symbolic.h
- - cfi.rs
  - common.rs
  - core.rs
  - debuginfo.rs
  - lib.rs
  - proguard.rs
  - sourcemap.rs
  - sourcemapcache.rs
  - symcache.rs
  - utils.rs
- Cargo.toml
- cbindgen.toml
- Makefile
- README.md
- - lib.rs
- - test_cfi.rs
- Cargo.toml
- - byteview.rs
  - cell.rs
  - heuristics.rs
  - lib.rs
  - path.rs
  - sourcelinks.rs
  - types.rs
- Cargo.toml
- README.md
- - breakpad_parser.rs
- - .gitignore
  - Cargo.toml
- - breakpad.rs
  - elf.rs
  - function_builder.rs
  - function_stack.rs
  - js.rs
  - lib.rs
  - object.rs
  - pe.rs
  - ppdb.rs
  - wasm.rs
- - test_objects.rs
  - test_pdb_srcsrv.rs
  - test_recursion_limits.rs
- Cargo.toml
- - lib.rs
  - swiftdemangle.cpp
- - test_cpp.rs
  - test_detection.rs
  - test_msvc.rs
  - test_objcpp.rs
  - test_swift.rs
- build.rs
- Cargo.toml
- README.md
- - lib.rs
- Cargo.toml
- - .gitignore
  - Cargo.toml
- - lib.rs
- - test_caches.rs
  - test_ppdb.rs
- Cargo.toml
- - lib.rs
  - lookup.rs
  - raw.rs
  - writer.rs
- - integration.rs
- Cargo.toml
- - bench_writer.rs
- - error.rs
  - lib.rs
  - lookup.rs
  - raw.rs
  - utils.rs
  - writer.rs
- - breakpad.rs
  - test_cache.rs
  - test_transformers.rs
  - test_writer.rs
- Cargo.toml
- - libgallium_dri.sym
  - xul.sym
  - xul2.sym
- - build.sh
  - main.c
  - testachio.c
  - testachio.h
  - testaroni.c
  - testaroni.h
- - lib.rs
- Cargo.toml
- - container.rs
  - context.rs
  - error.rs
  - lib.rs
  - logs.rs
  - xml.rs
- - test_unreal_crash_parse.rs
- Cargo.toml
- - package-smoke.test.mjs
  - package.json
  - README.md
  - smoke-test.mjs
- - il2cpp.rs
  - lib.rs
  - utils.rs
- - debuginfo.rs
  - il2cpp.rs
- build-npm.sh
- Cargo.toml
.clang-format
.codecov.yml
.craft.yml
.editorconfig
.gitattributes
.gitignore
.semgrepignore
Cargo.lock
Cargo.toml
CHANGELOG.md
LICENSE
Makefile
README.md
run
warden.toml

# Installation Guide

1. Get the code

git clone https://github.com/getsentry/symbolic

Downloads the entire project code from GitHub to your computer.

cd symbolic

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Python 3 Python is required to use pip.

pip install --editable ./py

Installs the package published on PyPI directly — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.

cd symbolic-wasm/npm

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install --editable ./py

Installs the package published on PyPI directly — no need to clone the source.

SYMBOLIC_DEBUG=1 pip install --editable ./py

Installs the Python libraries listed in requirements.txt (or similar).

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

5. Rust

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Rust (rustup) Installing via rustup also installs cargo.

cargo check --all --all-features

Type this command into your terminal and run it.

cargo test --all --all-features

Type this command into your terminal and run it.

✅ If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

6. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make format

Compiles the code based on the generated build configuration to produce an executable.

make lint

Compiles the code based on the generated build configuration to produce an executable.

make pytest

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

symbolic

File Explorer

# Installation Guide

2. Official Install Script

3. Node.js

4. Python

5. Rust

6. Make

Today's picks

Was this content helpful?

Recent Feedback

symbolic

File Explorer

# Installation Guide

2. Official Install Script

3. Node.js

4. Python

5. Rust

6. Make

Today's picks

Was this content helpful?

Recent Feedback

Download README