HOWTO

[frobnitzem]

I would like to know how I can run the symbol extraction process myself.
There are other projects, e.g. symbol-exporter that also see value in being able to look through these symbols. I want to do things like providing a graphical map of my projects' collective APIs that links to documentation about concepts shared between projects. However, even just a word bubble would be nice.

The symbol extraction documentation notes that it is based on tree-sitter and stack-graphs. However, neither of those repositories has useful information on how to run the process on a local source package and store the results in a local database.

[hendrikvanantwerpen]

Hi @frobnitzem! The documentation page you link to refers to several features related to code navigation.

In particular the precise code navigation is powered by the open source stack-graphs library you link to. For the languages we've published so far, a CLI is available that supports indexing directories and querying the resulting database. There's not a lot of documentation yet, but the CLI has decent help output. See https://github.com/github/stack-graphs/tree/main/languages/tree-sitter-stack-graphs-typescript#command-line-program for the TypeScript CLI (which is the most mature language we've published so far).

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬