alt-romes / llvm-c-search

Terminal interface to search the LLVM-C API

Introduction

This tool scrapes the LLVM-C API and provides a TUI to search and navigate the API from the terminal. It came to be from the lack of search options in the llvm-c official documentation, and difficulty to navigate the hyperlinks as a beginner to llvm.

To find, for example, the sext corresponding instruction, instead of clicking all apparently related hyperlinks of sub-modules (in fact, this exact function was the "last-drop", and the reason why I wrote program), simply run the program, and then filter for sext by tapping / when the TUI loads.

Additionally, pressing enter on the selected item will open the corresponding llvm-c API webpage on the browser.

v0.4 Preview

Searching for the function that returns the LLVM pointer type of an LLVM type

Build and Run

go get # fetch packages
go build # build program

./search # run program