Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ran pre-commit on lcandy2's branch and fixed README.md to ensure CI passes #90

Closed
wants to merge 3 commits into from
Closed

Ran pre-commit on lcandy2's branch and fixed README.md to ensure CI passes #90

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a22dea7
Feat GitIngest Browser Extension
lcandy2 Dec 26, 2024
d4db057
Merge branch 'main' into main
cyclotruc Dec 31, 2024
7500137
Ran pre-commit on lcandy2's branch and fixed README.md for CI to pass
filipchristiansen Dec 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@

Turn any Git repository into a prompt-friendly text ingest for LLMs.

You can also replace `hub` with `ingest` in any github url to access the coresponding digest
You can also replace `hub` with `ingest` in any github url to access the coresponding digest.

[gitingest.com](https://gitingest.com)
[gitingest.com](https://gitingest.com) · [Chrome Extension](https://chromewebstore.google.com/detail/adfjahbijlkjfoicpjkhjicpjpjfaood) · [Firefox Add-on](https://addons.mozilla.org/firefox/addon/gitingest)

## 🚀 Features

Expand All @@ -32,6 +32,18 @@ You can also replace `hub` with `ingest` in any github url to access the corespo
pip install gitingest
```

## 🧩 Browser Extension Usage

<!-- markdownlint-disable MD033 -->
<a href="https://chromewebstore.google.com/detail/adfjahbijlkjfoicpjkhjicpjpjfaood"><img height="48" src="https://github.com/user-attachments/assets/20a6e44b-fd46-4e6c-8ea6-aad436035753" alt="Available in the Chrome Web Store"/></a>
<a href="https://addons.mozilla.org/firefox/addon/gitingest"><img height="48" src="https://github.com/user-attachments/assets/c0e99e6b-97cf-4af2-9737-099db7d3538b" alt="Get The Add-on for Firefox" /></a>
<a href="https://microsoftedge.microsoft.com/addons/detail/nfobhllgcekbmpifkjlopfdfdmljmipf"><img height="48" src="https://github.com/user-attachments/assets/204157eb-4cae-4c0e-b2cb-db514419fd9e" alt="Get from the Edge Add-ons" /></a>
<!-- markdownlint-enable MD033 -->

The extension is open source at [lcandy2/gitingest-extension](https://github.com/lcandy2/gitingest-extension).
For anyone who wants install it manually, you may download it [here](https://github.com/lcandy2/gitingest-extension/releases).
Issues and feature requests are welcome to the repo.

## 💡 Command Line usage

The `gitingest` command line tool allows you to analyze codebases and create a text dump of their contents.
Expand Down Expand Up @@ -87,11 +99,11 @@ If you are hosting it on a domain, you can specify the allowed hostnames via env

## 🛠️ Stack

- [Tailwind CSS](https://tailwindcss.com/) - Frontend
- [Tailwind CSS](https://tailwindcss.com) - Frontend
- [FastAPI](https://github.com/fastapi/fastapi) - Backend framework
- [Jinja2](https://jinja.palletsprojects.com/) - HTML templating
- [Jinja2](https://jinja.palletsprojects.com) - HTML templating
- [tiktoken](https://github.com/openai/tiktoken) - Token estimation
- [apianalytics.dev](https://www.apianalytics.dev/) - Simple Analytics
- [apianalytics.dev](https://www.apianalytics.dev) - Simple Analytics

## ✔️ Contributing to Gitingest

Expand Down
Loading