Metadata-Version: 2.4
Name: aelsha-repolantern
Version: 1.0.0
Summary: AELSHA™ RepoLantern: turn any Git repository into clear documentation for beginners, senior engineers and architects, with your own LLM key.
Author: AELSHA INNOVATIONS OPC PRIVATE LIMITED
License-Expression: Apache-2.0
Project-URL: Homepage, https://repolantern.aelsha.com
Project-URL: Documentation, https://repolantern.aelsha.com/docs
Keywords: documentation,llm,git,langgraph,fastapi,code-documentation,bring-your-own-key
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Framework :: FastAPI
Classifier: Topic :: Software Development :: Documentation
Classifier: Operating System :: OS Independent
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: langchain==1.4.5
Requires-Dist: langchain-core==1.6.10
Requires-Dist: langchain-google-genai==4.4.2
Requires-Dist: langchain-anthropic==1.7.6
Requires-Dist: langchain-openai==1.7.2
Requires-Dist: langchain-text-splitters==1.1.3
Requires-Dist: langgraph==1.2.15
Requires-Dist: langgraph-checkpoint==4.3.0
Requires-Dist: langgraph-checkpoint-sqlite==3.1.2
Requires-Dist: aiosqlite==0.22.1
Requires-Dist: google-cloud-storage==3.17.0
Requires-Dist: fastapi==0.143.1
Requires-Dist: uvicorn[standard]==0.54.0
Requires-Dist: sse-starlette==3.5.0
Requires-Dist: pydantic==2.14.1
Requires-Dist: pydantic-settings==2.16.0
Requires-Dist: firebase-admin==7.7.0
Requires-Dist: google-auth==2.62.0
Requires-Dist: httpx==0.28.1
Requires-Dist: markdown-it-py==4.2.0
Requires-Dist: nh3==0.3.7
Requires-Dist: pyyaml==6.0.3
Requires-Dist: python-docx==1.2.0
Requires-Dist: python-pptx==1.0.2
Requires-Dist: weasyprint==70.0
Requires-Dist: pygments==2.21.0
Requires-Dist: lizard==1.24.1
Requires-Dist: pathspec==1.1.1
Requires-Dist: pillow==13.0.0
Requires-Dist: langchain-aws==1.8.2
Requires-Dist: boto3==1.43.114
Requires-Dist: botocore==1.43.114
Requires-Dist: mcp==2.3.0
Requires-Dist: a2a-sdk==1.2.2
Requires-Dist: opentelemetry-api==1.45.1
Requires-Dist: opentelemetry-sdk==1.45.1
Requires-Dist: opentelemetry-exporter-otlp-proto-http==1.45.1
Requires-Dist: starlette==1.8.0
Requires-Dist: anyio==4.15.1
Requires-Dist: httpcore==1.0.9
Requires-Dist: cryptography==50.0.2
Dynamic: license-file

# AELSHA™ RepoLantern

**Understand an unfamiliar codebase before you change it.** RepoLantern turns any Git repository into a grounded
guide for beginners, senior engineers or architects. Every guide includes architecture diagrams and citations to exact
lines, and every file and code name in it is checked against the code. It runs with your own AI model key; the key is
never stored.

This package is the command-line tool. It runs the same pipeline as the web app at
[repolantern.aelsha.com](https://repolantern.aelsha.com), on your own machine.

## Install

You need Python 3.12 or newer, git 2.50.1 or newer, Graphviz (diagrams) and Pango (PDF export):

| System | Command |
|---|---|
| macOS | `brew install git graphviz pango pipx` |
| Debian or Ubuntu | `sudo apt-get install git graphviz libpango-1.0-0 libpangoft2-1.0-0 pipx` |
| Windows | Use WSL (Ubuntu) and follow the Debian line |

```
pipx install aelsha-repolantern
repolantern --version
```

## Run

Put your key in an environment variable, never on the command line:

```
export OPENAI_API_KEY=...
repolantern run https://github.com/octocat/Hello-World --provider openai --model gpt-6-luna --cap 0.50
```

The run continues only if the estimate's upper end is within `--cap` (US dollars). Otherwise it stops before spending
anything. The guide, an assessment and a cost report are written to `./out`.

RepoLantern works with Google Gemini, Vertex AI, Anthropic Claude, OpenAI, AWS Bedrock, Microsoft Foundry and any
OpenAI-compatible service, including free models on OpenRouter at $0. If a model's limit runs out, the run pauses;
`repolantern resume <job-id>` continues later on the same or another model, without paying twice for finished work.

## Learn more

- [Command-line guide](https://repolantern.aelsha.com/docs/cli): every provider, option and output
- [Set up your AI provider](https://repolantern.aelsha.com/setup)
- [How every guide is checked](https://repolantern.aelsha.com/evals) and [security](https://repolantern.aelsha.com/security)
- Security reports: [security@aelsha.com](mailto:security@aelsha.com)

Built with AELSHA™ ASTRA by AELSHA INNOVATIONS OPC PRIVATE LIMITED. Licensed under the Apache License 2.0.
