https://github.com/mohdzain98/gnost

GNOST helps developers understand unfamiliar codebases by automatically identifying entry points, execution flow, and core logic.
https://github.com/mohdzain98/gnost

cli code-analysis developer-tools mermaid onboarding

Last synced: 6 months ago
JSON representation

GNOST helps developers understand unfamiliar codebases by automatically identifying entry points, execution flow, and core logic.

• Host: GitHub
• URL: https://github.com/mohdzain98/gnost
• Owner: mohdzain98
• License: mit
• Created: 2025-12-27T20:04:37.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2025-12-28T20:30:10.000Z (6 months ago)
• Last Synced: 2025-12-31T09:56:35.467Z (6 months ago)
• Topics: cli, code-analysis, developer-tools, mermaid, onboarding
• Language: Python
• Homepage: https://gnost.readthedocs.io/
• Size: 37.1 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# GNOST — Codebase Knowledge

![PyPI](https://img.shields.io/pypi/v/gnost)

![Python](https://img.shields.io/pypi/pyversions/gnost)

![License](https://img.shields.io/pypi/l/gnost)

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:

```bash

pip install gnost

```

Run the onboarding scan:

```bash

gnost onboard .

```

Minimal usage examples:

```bash

gnost summary .

gnost stats .

```

Supported languages: Python, JavaScript, TypeScript, Java.

## Project Links

### Full Documentation and Usage:

[![Docs](https://img.shields.io/readthedocs/gnost?label=docs)](https://gnost.readthedocs.io)

### Changelog:

[![Changelog](https://img.shields.io/badge/changelog-CHANGELOG.md-blue)](./CHANGELOG.md)

## 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.

[![Onboarding](https://img.shields.io/badge/onboarding-ONBOARD.md-cyan)](./ONBOARD.md)

Generated by GNOST to help understand the codebase.

## License

MIT License