GNOST — Codebase Knowledge
Project description
GNOST — Codebase Knowledge
GNOST helps developers understand unfamiliar codebases by automatically identifying entry points, execution flow, and core logic. It is designed for first-day onboarding, not just code statistics.
Why GNOST?
- Quickly build a mental model of a new codebase
- See how execution flows without reading everything
- Generate onboarding docs and Mermaid diagrams with one command
What GNOST Does
- Detects where execution starts
- Infers high-level execution flow
- Identifies hotspot files (most important code)
- Generates onboarding documentation
- Produces Mermaid flow diagrams
- Works across multiple languages
Getting Started
Install:
pip install gnost
Run the onboarding scan:
gnost onboard .
Minimal usage examples:
gnost summary .
gnost stats .
Supported languages: Python, JavaScript, TypeScript, Java.
Project Links
Full Documentation and Usage:
Changelog:
Philosophy
GNOST focuses on fast, heuristic-based static analysis to help developers onboard quickly. It prioritizes clarity and actionable summaries over exhaustive analysis.
Onboarding
This repository includes an auto-generated onboarding guide.
Generated by GNOST to help understand the codebase.
License
MIT License
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file gnost-0.2.0.tar.gz.
File metadata
- Download URL: gnost-0.2.0.tar.gz
- Upload date:
- Size: 3.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e2d31f05cd67c89e0ab23316ac1ae57d65efbd4403907ed7c0e38625c9a4d0fb
|
|
| MD5 |
73eb68a3ffc1459de1914b1677071a33
|
|
| BLAKE2b-256 |
2433dc50ca64513a79b9b20a9eb0e59af77da8e40b7db9353aeeb34a9405b199
|
File details
Details for the file gnost-0.2.0-py3-none-any.whl.
File metadata
- Download URL: gnost-0.2.0-py3-none-any.whl
- Upload date:
- Size: 4.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c167afa13c05f1292bbaf053f84a9ae48d3383bf15d4aeb928c7ece562f9ff99
|
|
| MD5 |
c35d6a4b9d12f5f747a544729ee0cf3c
|
|
| BLAKE2b-256 |
938a1206a98f935dcfca2d20c6ba909909519d2e1f802d60586a9dfc7f278898
|
