[{"_1":2,"_151":-5,"_152":-5},"loaderData",{"_3":4,"_13":14,"_20":21,"_130":131},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","routes/_layout.r.$namespace.$reponame",{"_22":23,"_24":-5,"_25":11,"_26":11,"_27":28,"_29":30,"_31":-5,"_32":11,"_33":34,"_83":-5,"_84":85,"_123":-5,"_124":11,"_125":17,"_126":11,"_127":-5,"_128":129},"canonicalUrl","https://hub.docker.com/r/gyarbij/gitingest/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","gyarbij","reponame","gitingest","cloudBuildSource","isAutobuildsAvailable","repo",{"_35":36,"_37":38,"_40":41,"_42":43,"_44":11,"_45":46,"_47":48,"_49":50,"_52":30,"_27":28,"_53":54,"_55":39,"_56":57,"_58":59,"_60":61,"_62":-5,"_63":57,"_64":65,"_66":11,"_67":28,"_68":69,"_74":11,"_75":76,"_80":28,"_81":82},"categories",[],"content_types",[39],"image","date_registered","2024-12-09T17:51:36.874127Z","description","","is_private","last_updated","2024-12-09T20:35:23.233616Z","last_modified","2025-12-28T21:53:47.286428Z","media_types",[51],"application/vnd.docker.container.image.v1+json","name","pull_count",1392,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Gitingest\n\n[![Screenshot of Gitingest front page](https://raw.githubusercontent.com/coderamp-labs/gitingest/refs/heads/main/docs/frontpage.png)](https://gitingest.com)\n\n\n\n

\n \n $\"PyPI\"$ \n $\"Python$ \n
\n \n $\"CI\"$ \n\n $\"Ruff\"$ \n $\"OpenSSF$ \n
\n $\"License\"$ \n $\"Downloads\"$ \n $\"GitHub$ \n $\"Discord\"$ \n
\n $\"Trendshift\"$ \n

\n\n\nTurn any Git repository into a prompt-friendly text ingest for LLMs.\n\nYou can also replace `hub` with `ingest` in any GitHub URL to access the corresponding digest.\n\n\n[gitingest.com](https://gitingest.com) · [Chrome Extension](https://chromewebstore.google.com/detail/adfjahbijlkjfoicpjkhjicpjpjfaood) · [Firefox Add-on](https://addons.mozilla.org/firefox/addon/gitingest)\n\n\n[Deutsch](https://www.readme-i18n.com/coderamp-labs/gitingest?lang=de) |\n[Español](https://www.readme-i18n.com/coderamp-labs/gitingest?lang=es) |\n[Français](https://www.readme-i18n.com/coderamp-labs/gitingest?lang=fr) |\n[日本語](https://www.readme-i18n.com/coderamp-labs/gitingest?lang=ja) |\n[한국어](https://www.readme-i18n.com/coderamp-labs/gitingest?lang=ko) |\n[Português](https://www.readme-i18n.com/coderamp-labs/gitingest?lang=pt) |\n[Русский](https://www.readme-i18n.com/coderamp-labs/gitingest?lang=ru) |\n[中文](https://www.readme-i18n.com/coderamp-labs/gitingest?lang=zh)\n\n## 🚀 Features\n\n- **Easy code context**: Get a text digest from a Git repository URL or a directory\n- **Smart Formatting**: Optimized output format for LLM prompts\n- **Statistics about**:\n - File and directory structure\n - Size of the extract\n - Token count\n- **CLI tool**: Run it as a shell command\n- **Python package**: Import it in your code\n\n## 📚 Requirements\n\n- Python 3.8+\n- For private repositories: A GitHub Personal Access Token (PAT). [Generate your token **here**!](https://github.com/settings/tokens/new?description=gitingest&scopes=repo)\n\n### 📦 Installation\n\nGitingest is available on [PyPI](https://pypi.org/project/gitingest/).\nYou can install it using `pip`:\n\n```bash\npip install gitingest\n```\n\nor\n\n```bash\npip install gitingest[server]\n```\n\nto include server dependencies for self-hosting.\n\nHowever, it might be a good idea to use `pipx` to install it.\nYou can install `pipx` using your preferred package manager.\n\n```bash\nbrew install pipx\napt install pipx\nscoop install pipx\n...\n```\n\nIf you are using pipx for the first time, run:\n\n```bash\npipx ensurepath\n```\n\n```bash\n# install gitingest\npipx install gitingest\n```\n\n## 🧩 Browser Extension Usage\n\n\n $\"Available$ \n $\"Get$ \n $\"Get$ \n\n\nThe extension is open source at [lcandy2/gitingest-extension](https://github.com/lcandy2/gitingest-extension).\n\nIssues and feature requests are welcome to the repo.\n\n## 💡 Command line usage\n\nThe `gitingest` command line tool allows you to analyze codebases and create a text dump of their contents.\n\n```bash\n# Basic usage (writes to digest.txt by default)\ngitingest /path/to/directory\n\n# From URL\ngitingest https://github.com/coderamp-labs/gitingest\n\n# or from specific subdirectory\ngitingest https://github.com/coderamp-labs/gitingest/tree/main/src/gitingest/utils\n```\n\nFor private repositories, use the `--token/-t` option.\n\n```bash\n# Get your token from https://github.com/settings/personal-access-tokens\ngitingest https://github.com/username/private-repo --token github_pat_...\n\n# Or set it as an environment variable\nexport GITHUB_TOKEN=github_pat_...\ngitingest https://github.com/username/private-repo\n\n# Include repository submodules\ngitingest https://github.com/username/repo-with-submodules --include-submodules\n```\n\nBy default, files listed in `.gitignore` are skipped. Use `--include-gitignored` if you\nneed those files in the digest.\n\nBy default, the digest is written to a text file (`digest.txt`) in your current working directory. You can customize the output in two ways:\n\n- Use `--output/-o ` to write to a specific file.\n- Use `--output/-o -` to output directly to `STDOUT` (useful for piping to other tools).\n\nSee more options and usage details with:\n\n```bash\ngitingest --help\n```\n\n## 🐍 Python package usage\n\n```python\n# Synchronous usage\nfrom gitingest import ingest\n\nsummary, tree, content = ingest(\"path/to/directory\")\n\n# or from URL\nsummary, tree, content = ingest(\"https://github.com/coderamp-labs/gitingest\")\n\n# or from a specific subdirectory\nsummary, tree, content = ingest(\"https://github.com/coderamp-labs/gitingest/tree/main/src/gitingest/utils\")\n```\n\nFor private repositories, you can pass a token:\n\n```python\n# Using token parameter\nsummary, tree, content = ingest(\"https://github.com/username/private-repo\", token=\"github_pat_...\")\n\n# Or set it as an environment variable\nimport os\nos.environ[\"GITHUB_TOKEN\"] = \"github_pat_...\"\nsummary, tree, content = ingest(\"https://github.com/username/private-repo\")\n\n# Include repository submodules\nsummary, tree, content = ingest(\"https://github.com/username/repo-with-submodules\", include_submodules=True)\n```\n\nBy default, this won't write a file but can be enabled with the `output` argument.\n\n```python\n# Asynchronous usage\nfrom gitingest import ingest_async\nimport asyncio\n\nresult = asyncio.run(ingest_async(\"path/to/directory\"))\n```\n\n### Jupyter notebook usage\n\n```python\nfrom gitingest import ingest_async\n\n# Use await directly in Jupyter\nsummary, tree, content = await ingest_async(\"path/to/directory\")\n\n```\n\nThis is because Jupyter notebooks are asynchronous by default.\n\n## 🐳 Self-host\n\n### Using Docker\n\n1. Build the image:\n\n ``` bash\n docker build -t gitingest .\n ```\n\n2. Run the container:\n\n ``` bash\n docker run -d --name gitingest -p 8000:8000 gitingest\n ```\n\nThe application will be available at `http://localhost:8000`.\n\nIf you are hosting it on a domain, you can specify the allowed hostnames via env variable `ALLOWED_HOSTS`.\n\n ```bash\n # Default: \"gitingest.com, *.gitingest.com, localhost, 127.0.0.1\".\n ALLOWED_HOSTS=\"example.com, localhost, 127.0.0.1\"\n ```\n\n### Environment Variables\n\nThe application can be configured using the following environment variables:\n\n- **ALLOWED_HOSTS**: Comma-separated list of allowed hostnames (default: \"gitingest.com, *.gitingest.com, localhost, 127.0.0.1\")\n- **GITINGEST_METRICS_ENABLED**: Enable Prometheus metrics server (set to any value to enable)\n- **GITINGEST_METRICS_HOST**: Host for the metrics server (default: \"127.0.0.1\")\n- **GITINGEST_METRICS_PORT**: Port for the metrics server (default: \"9090\")\n- **GITINGEST_SENTRY_ENABLED**: Enable Sentry error tracking (set to any value to enable)\n- **GITINGEST_SENTRY_DSN**: Sentry DSN (required if Sentry is enabled)\n- **GITINGEST_SENTRY_TRACES_SAMPLE_RATE**: Sampling rate for performance data (default: \"1.0\", range: 0.0-1.0)\n- **GITINGEST_SENTRY_PROFILE_SESSION_SAMPLE_RATE**: Sampling rate for profile sessions (default: \"1.0\", range: 0.0-1.0)\n- **GITINGEST_SENTRY_PROFILE_LIFECYCLE**: Profile lifecycle mode (default: \"trace\")\n- **GITINGEST_SENTRY_SEND_DEFAULT_PII**: Send default personally identifiable information (default: \"true\")\n- **S3_ALIAS_HOST**: Public URL/CDN for accessing S3 resources (default: \"127.0.0.1:9000/gitingest-bucket\")\n- **S3_DIRECTORY_PREFIX**: Optional prefix for S3 file paths (if set, prefixes all S3 paths with this value)\n\n### Using Docker Compose\n\nThe project includes a `compose.yml` file that allows you to easily run the application in both development and production environments.\n\n#### Compose File Structure\n\nThe `compose.yml` file uses YAML anchoring with `&app-base` and `<<: *app-base` to define common configuration that is shared between services:\n\n```yaml\n# Common base configuration for all services\nx-app-base: &app-base\n build:\n context: .\n dockerfile: Dockerfile\n ports:\n - \"${APP_WEB_BIND:-8000}:8000\" # Main application port\n - \"${GITINGEST_METRICS_HOST:-127.0.0.1}:${GITINGEST_METRICS_PORT:-9090}:9090\" # Metrics port\n # ... other common configurations\n```\n\n#### Services\n\nThe file defines three services:\n\n1. **app**: Production service configuration\n - Uses the `prod` profile\n - Sets the Sentry environment to \"production\"\n - Configured for stable operation with `restart: unless-stopped`\n\n2. **app-dev**: Development service configuration\n - Uses the `dev` profile\n - Enables debug mode\n - Mounts the source code for live development\n - Uses hot reloading for faster development\n\n3. **minio**: S3-compatible object storage for development\n - Uses the `dev` profile (only available in development mode)\n - Provides S3-compatible storage for local development\n - Accessible via:\n - API: Port 9000 ([localhost:9000](http://localhost:9000))\n - Web Console: Port 9001 ([localhost:9001](http://localhost:9001))\n - Default admin credentials:\n - Username: `minioadmin`\n - Password: `minioadmin`\n - Configurable via environment variables:\n - `MINIO_ROOT_USER`: Custom admin username (default: minioadmin)\n - `MINIO_ROOT_PASSWORD`: Custom admin password (default: minioadmin)\n - Includes persistent storage via Docker volume\n - Auto-creates a bucket and application-specific credentials:\n - Bucket name: `gitingest-bucket` (configurable via `S3_BUCKET_NAME`)\n - Access key: `gitingest` (configurable via `S3_ACCESS_KEY`)\n - Secret key: `gitingest123` (configurable via `S3_SECRET_KEY`)\n - These credentials are automatically passed to the app-dev service via environment variables:\n - `S3_ENDPOINT`: URL of the MinIO server\n - `S3_ACCESS_KEY`: Access key for the S3 bucket\n - `S3_SECRET_KEY`: Secret key for the S3 bucket\n - `S3_BUCKET_NAME`: Name of the S3 bucket\n - `S3_REGION`: Region for the S3 bucket (default: us-east-1)\n - `S3_ALIAS_HOST`: Public URL/CDN for accessing S3 resources (default: \"127.0.0.1:9000/gitingest-bucket\")\n\n#### Usage Examples\n\nTo run the application in development mode:\n\n```bash\ndocker compose --profile dev up\n```\n\nTo run the application in production mode:\n\n```bash\ndocker compose --profile prod up -d\n```\n\nTo build and run the application:\n\n```bash\ndocker compose --profile prod build\ndocker compose --profile prod up -d\n```\n\n## 🤝 Contributing\n\n### Non-technical ways to contribute\n\n- **Create an Issue**: If you find a bug or have an idea for a new feature, please [create an issue](https://github.com/coderamp-labs/gitingest/issues/new) on GitHub. This will help us track and prioritize your request.\n- **Spread the Word**: If you like Gitingest, please share it with your friends, colleagues, and on social media. This will help us grow the community and make Gitingest even better.\n- **Use Gitingest**: The best feedback comes from real-world usage! If you encounter any issues or have ideas for improvement, please let us know by [creating an issue](https://github.com/coderamp-labs/gitingest/issues/new) on GitHub or by reaching out to us on [Discord](https://discord.com/invite/zerRaGK9EC).\n\n### Technical ways to contribute\n\nGitingest aims to be friendly for first time contributors, with a simple Python and HTML codebase. If you need any help while working with the code, reach out to us on [Discord](https://discord.com/invite/zerRaGK9EC). For detailed instructions on how to make a pull request, see [CONTRIBUTING.md](./CONTRIBUTING.md).\n\n## 🛠️ Stack\n\n- [Tailwind CSS](https://tailwindcss.com) - Frontend\n- [FastAPI](https://github.com/fastapi/fastapi) - Backend framework\n- [Jinja2](https://jinja.palletsprojects.com) - HTML templating\n- [tiktoken](https://github.com/openai/tiktoken) - Token estimation\n- [posthog](https://github.com/PostHog/posthog) - Amazing analytics\n- [Sentry](https://sentry.io) - Error tracking and performance monitoring\n\n### Looking for a JavaScript/FileSystemNode package?\n\nCheck out the NPM alternative 📦 Repomix: \n\n## 🚀 Project Growth\n\n[![Star History Chart](https://api.star-history.com/svg?repos=coderamp-labs/gitingest&type=Date)](https://star-history.com/#coderamp-labs/gitingest&Date)\n","has_starred","hub_user","immutable_tags_settings",{"_70":11,"_71":72},"enabled","rules",[73],".*","is_automated","permissions",{"_77":17,"_78":11,"_79":11},"read","write","admin","user","storage_size",156221717,"orgData","recentTags",[86],{"_87":39,"_88":89,"_90":91,"_92":93,"_94":95,"_96":97,"_45":112,"_113":89,"_114":28,"_115":51,"_52":116,"_117":118,"_119":103,"_120":112,"_121":61,"_122":17},"content_type","creator",10669458,"digest","sha256:ac83a300dca851e00fd91e5d2fa9ac01d78e7e294609d0e600a8fe138755e1a7","full_size",100166333,"id",810516833,"images",[98],{"_99":100,"_90":91,"_101":43,"_102":103,"_104":105,"_106":107,"_108":43,"_109":-5,"_110":93,"_58":61,"_111":-5},"architecture","amd64","features","last_pulled","2026-09-09T01:14:09.886244324Z","last_pushed","2024-12-09T20:35:23Z","os","linux","os_features","os_version","size","variant","2024-12-09T20:35:23.060906Z","last_updater","last_updater_username","media_type","latest","repository",25909921,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_33":132,"_139":140,"_128":149,"_150":11},{"_35":133,"_37":134,"_40":41,"_42":43,"_44":11,"_45":46,"_47":48,"_49":135,"_52":30,"_27":28,"_53":54,"_55":39,"_56":57,"_58":59,"_60":61,"_62":-5,"_63":57,"_64":65,"_66":11,"_67":28,"_68":136,"_74":11,"_75":138,"_80":28,"_81":82},[],[39],[51],{"_70":11,"_71":137},[73],{"_77":17,"_78":11,"_79":11},"tags",{"_141":59,"_142":-5,"_143":-5,"_144":145},"count","next","previous","results",[146],{"_87":39,"_88":89,"_90":91,"_92":93,"_94":95,"_96":147,"_45":112,"_113":89,"_114":28,"_115":51,"_52":116,"_117":118,"_119":103,"_120":112,"_121":61,"_122":17},[148],{"_99":100,"_90":91,"_101":43,"_102":103,"_104":105,"_106":107,"_108":43,"_109":-5,"_110":93,"_58":61,"_111":-5},[],"canDeleteTags","actionData","errors"]

gyarbij/gitingest

Tags for gyarbij/gitingest