How cyclotruc/gitingest works
Gitingest turns a repository URL or local directory into a prompt-ready digest with a file tree, content, and size/token statistics. Users can invoke it through the Python API or CLI, or submit repositories through the self-hosted web service; the service can cache and serve digest files through S3. The graph follows input parsing, repository access, file analysis, formatting, and web delivery. Several server and utility relationships are supported only by the SOURCE INDEX; unsampled implementation details are not inferred.
Main entry points: query_processor.py Request processor · entrypoint.py Ingest entrypoint · main.py Web application · ingest.py Ingest routes
Components 28
Ingestion core
- Ingest entrypoint
src/gitingest/entrypoint.py - Query parser
src/gitingest/query_parser.py - Repository clone
src/gitingest/clone.py - File analysis
src/gitingest/ingestion.py - Filesystem model
src/gitingest/schemas/filesystem.py - Digest formatter
src/gitingest/output_formatter.py - Ingestion query
src/gitingest/schemas/ingestion.py - Clone config
src/gitingest/schemas/cloning.py
Git and filtering
- Git operations
src/gitingest/utils/git_utils.py - Query helpers
src/gitingest/utils/query_parser_utils.py - Ignore rules
src/gitingest/utils/ignore_patterns.py - Pattern matching
src/gitingest/utils/pattern_utils.py - Logging
src/gitingest/utils/logging_config.py
Web service
- Web application
src/server/main.py - Ingest routes
src/server/routers/ingest.py - Request processor
src/server/query_processor.py - Request models
src/server/models.py - Server configuration
src/server/server_config.py - Route helpers
src/server/routers_utils.py - Landing routes
src/server/routers/index.py - Dynamic routes
src/server/routers/dynamic.py
Digest delivery
- S3 storage
src/server/s3_utils.py - Digest download
src/server/routers/ingest.py
Other components
- User
- CLI
src/gitingest/__main__.py - Python API
src/gitingest/__init__.py - Web user
- Browser interface
src/static/js/index.js
Connections 33
- User → CLI: runs
README.md - User → Python API: calls
README.md - CLI → Ingest entrypoint: invokes
- Python API → Ingest entrypoint: exposes
- Ingest entrypoint → Query parser: parses input
src/gitingest/entrypoint.py - Ingest entrypoint → Repository clone: clones repository
src/gitingest/entrypoint.py - Ingest entrypoint → File analysis: processes files
src/gitingest/entrypoint.py - Ingest entrypoint → Ignore rules: loads rules
src/gitingest/entrypoint.py - Ingest entrypoint → Pattern matching: applies patterns
src/gitingest/entrypoint.py - Query parser → Query helpers: uses helpers
src/gitingest/query_parser.py - Query helpers → Git operations: resolves refs
src/gitingest/utils/query_parser_utils.py - Query parser → Ingestion query: creates query
src/gitingest/query_parser.py - Ingestion query → Clone config: builds config
src/gitingest/schemas/ingestion.py - Repository clone → Clone config: uses config
src/gitingest/clone.py - Repository clone → Git operations: uses Git
src/gitingest/clone.py - File analysis → Filesystem model: builds tree
src/gitingest/ingestion.py - File analysis → Digest formatter: formats output
src/gitingest/ingestion.py - Pattern matching → Ignore rules: uses rules
src/gitingest/utils/pattern_utils.py - Web user → Browser interface: submits repository
- Web application → Ingest routes: registers routes
src/server/main.py - Web application → Landing routes: registers routes
src/server/main.py - Web application → Dynamic routes: registers routes
src/server/main.py - Ingest routes → Route helpers: delegates request
src/server/routers/ingest.py - Route helpers → Request processor: processes ingest
src/server/routers_utils.py - Ingest routes → Request models: validates request
src/server/routers/ingest.py - Request processor → Query parser: parses repository
src/server/query_processor.py - Request processor → Repository clone: clones repository
src/server/query_processor.py - Request processor → File analysis: analyzes files
src/server/query_processor.py - Request processor → Pattern matching: filters files
src/server/query_processor.py - Request processor → S3 storage: checks and stores
src/server/query_processor.py - Ingest routes → Digest download: serves digest
src/server/routers/ingest.py - Web application → Server configuration: loads settings
src/server/main.py - Request processor → Logging: logs activity
src/server/query_processor.py