https://github.com/alt-romes/llvm-c-search
Terminal interface to search the LLVM-C API
https://github.com/alt-romes/llvm-c-search
bubbletea c colly llvm llvm-c scraper tui
Last synced: 4 months ago
JSON representation
Terminal interface to search the LLVM-C API
- Host: GitHub
- URL: https://github.com/alt-romes/llvm-c-search
- Owner: alt-romes
- Created: 2021-12-13T12:16:07.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-12-26T01:44:53.000Z (almost 4 years ago)
- Last Synced: 2025-04-04T11:03:31.532Z (6 months ago)
- Topics: bubbletea, c, colly, llvm, llvm-c, scraper, tui
- Language: Go
- Homepage:
- Size: 120 KB
- Stars: 12
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## 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](https://llvm.org/doxygen/group__LLVMC.html) 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
```