A lightweight VS Code extension that provides d information about ELF files in a clean, no-frills webview-based interface. Combining features similar to readelf and file, it uses a modern stack to offer a fast and clean experience.
The extention adds an aditional editor, similar to how a hex editor might work, which is used to display a table view of information about the currenly open file.
This extension is designed to analyze ELF files by:
-
Extracting key information in a manner similar to traditional command line tools.
-
Presenting a detailed webview with a simple, efficient UI built with Svelte 5.
-
Efficiently handling large binaries and files with thousands of symbols.
It is implemented using a combination of Rust (via the libgoblin library running in WebAssembly) and TypeScript. Communication between the WebAssembly module and the extension is facilitated by WASI and WIT types, ensuring seamless type sharing and solid cross platform preformance.
-
Fast File Analysis: Quickly loads and displays basic file information for instant feedback.
-
Detailed Parsing: Processing of ELF binaries, even those with extensive symbols, done in the background to reduce felt lag.
-
No-Frills UI: A straightforward, functional webview that just works, no unnecessary complexity.
-
Lightweight & Cross Platform: At only a few hundred kb, the extension is snappy and works on macOS, Windows, Linux, and the web version of VS Code.
-
From the VS Code Marketplace: Search for
elfpreviewin the Extensions view and install it directly: marketplace.visualstudio.com/elfpreview -
Via VSIX: Download the provided
.vsixfile from elfpreview/releases and install it by running
code --install-extension elfpreview-<release>.vsixThere are two ways to activate the extention, with the Context Menu or Editor Selection.
Simply right click on an elf binary and select ELF: Show Preview
This is the normal view when you open a non text file. Vscode does not support editor selection by file type, only file extension, so you get this window.
When you select open anyway, you are presented with another dialog option to select the editor you wish to open the file with. elfpreview should be listed as an option.
There are no settings for this extension
-
TypeScript Generation Error:
Running
pnpm generateresults in typescript type error. This is becausewit2tsmixes up some types that need to be manually corrected. I am unsure if this is a bug or a skill issue. -
Rust Build Target Warnings:
Using the expected build target for rust,
wasm32-wasiorwasm32-wasip2results in linker errors. I am unsure why this is the case, or for that matter, why using a more generic target still works, but it does so 🤷
If you experence any other issues, please submit an issue here: elfpreview/issues
Added more information about symbols
Initial release
How files are processed:
-
Initial Display: Upon opening an ELF file, the extension quickly presents basic information (similar to the output of file).
-
Background Processing: The heavy lifting is performed in the background:
-
The binary is read into WebAssembly.
-
The Rust-based parser (using libgoblin) processes the file.
-
Data is then incrementally populated into the webview.
-
-
Communication: Type sharing between TypeScript and WebAssembly is managed via WASI and WIT, with stubs generated using Microsoft's wit2ts tool.
There are tests for the rust code located in the lib.rs file it self. The utilize a few test files in the fixtures directory. Some of these test binaries were taken from https://github.com/tmpout/elfs, primarily made by @netspooky
Some have strange architectures, some lots of headers, etc. The one that actually gave pause was a simple rust program compiled with symbols in a nix enviroment. Turns out it has several hundered symbols with massively long names which is a struggle to push through the ts wasm boundary and also just to display cleanly.