Set up your AI provider
Pick one provider, follow its steps, and paste what it gives you on the Model step. Your key is used for your job only and never stored.
Before you start
- One provider is enough. If you have none yet, Google Gemini has a free tier and is the quickest start.
- Make a key just for RepoLantern, give it a spending limit where the provider offers one, and delete it when you no longer need it. RepoLantern never stores keys: they stay in your browser tab and are sent only with the request that needs them.
- Where to paste: New guide → Model step → choose the provider. The form shows exactly the fields that provider needs, and Test connection checks them before anything is spent.
- Live-tested providers: Gemini, Vertex AI, Claude and OpenAI are tested with live accounts, and so is OpenRouter as an OpenAI-compatible service (a free NVIDIA model, $0). AWS Bedrock, Microsoft Foundry and the other OpenAI-compatible services are built and tested but not yet verified with a live account; the app says so on the Model step. Use Test connection first.
- Prices: RepoLantern shows where each model's price comes from. If it says Price unknown, open Advanced and enter your price per million tokens, so the estimate and your spending limit are right.
Google Gemini
What you need: an API key.
- Open Google AI Studio → API keys and sign in with a Google account.
- Choose Create API key, and pick or create a Google Cloud project for it.
- Copy the key and paste it into API key.
- Model:
gemini-3.8-flash(balanced) orgemini-3.5-flash-lite(cheapest).
The free tier has daily request limits; RepoLantern pauses when one is reached and resumes after the reset. Read Google's terms for the free tier before sending private code: use a key on a paid (billing-enabled) project for that.
Google Vertex AI
What you need: an API key, or a service-account key, and a location.
- In the Google Cloud console, choose a project with billing, and enable the Vertex AI API.
- Preferred: an API key. Create one for Vertex AI in your project and restrict it to the Vertex AI API. Paste it into API key.
- Or a service-account key: in IAM → Service accounts, create an account just for RepoLantern with only the
role Vertex AI User (
roles/aiplatform.user). Under Keys, add a JSON key, open the file, and paste its contents into Use a service-account key instead. Delete the key when you're done: it is long-lived. - Location: leave empty for
global, or type a region such asus-central1. - Model:
gemini-3.8-flashorgemini-3.5-flash-lite.
Anthropic Claude
What you need: an API key.
- Open the Claude Console → API keys and sign in.
- Choose Create key, name it "RepoLantern", and pick a workspace. A workspace with its own spend limit keeps costs contained.
- Copy the key (it starts with
sk-ant-) and paste it into API key. - Model:
claude-haiku-5-5(cheapest),claude-sonnet-5-5(balanced) orclaude-opus-5-5(most capable).
OpenAI
What you need: an API key.
- Open OpenAI → API keys and sign in.
- Choose Create new secret key, name it "RepoLantern", and pick a project. Set a budget on that project.
- Copy the key (it starts with
sk-) and paste it into API key. It is shown only once. - Model:
gpt-6-luna(recommended) orgpt-5.4-mini.
OpenAI-compatible services
What you need: an API key and the service's endpoint URL.
Choose the service in Service and the endpoint fills itself in. The model name comes from that service's model list. For OpenRouter, RepoLantern uses the price OpenRouter publishes for that exact model (shown as OpenRouter's published price, with a link to the model's page). For the other services it doesn't know the prices, so enter yours under Advanced (per million tokens) to keep the estimate and limit right.
| Service | Create a key | Endpoint (filled in for you) |
|---|---|---|
| OpenRouter | openrouter.ai/keys | https://openrouter.ai/api/v1 |
| Groq | console.groq.com/keys | https://api.groq.com/openai/v1 |
| DeepSeek | platform.deepseek.com/api_keys | https://api.deepseek.com |
| Mistral | console.mistral.ai (API keys) | https://api.mistral.ai/v1 |
| Together AI | api.together.ai settings | https://api.together.ai/v1 |
| Ollama Cloud | ollama.com/settings/keys | https://ollama.com/v1 |
Any other HTTPS service that speaks the OpenAI Chat Completions API works too: choose Another OpenAI-compatible
service and type its endpoint. Endpoints must be public https:// addresses.
Free models on OpenRouter
- What ":free" means. A model id that ends in
:free(for examplenvidia/nemotron-3.5-super-vl:free) is a free version of that model with its own, lower limits. RepoLantern shows its price as $0, from OpenRouter's own list. - How to pick one. On openrouter.ai/models, look for models whose price says
free, and copy the id that ends in
:freeinto Model. Choose one that handles long text well. - Limits. OpenRouter allows 20 requests a minute for free models, and 50 a day until your account has bought 10 credits (then 1,000 a day) (OpenRouter's limits). The daily number counts all your free-model requests together. RepoLantern paces itself to 20 a minute and pauses at 50 a day; if your account has more, raise the daily number under Advanced → Your model's limits. The estimate shows how many requests a guide needs.
- Your code and privacy. Your code goes to OpenRouter and to the company that runs the model. OpenRouter says it doesn't store prompts unless you opt in (data collection). The company behind each model has its own policy, and some may keep prompts or train on them. Your OpenRouter privacy settings decide whether those may be used, with a separate setting for free models (provider logging). Check them before you send private code.
- Free models can go away. OpenRouter can withdraw a free model; its list gives the date when one is planned, and RepoLantern shows that date next to the price. If a model is gone, pick another one.
- Your spending limit still applies. A free model costs $0, so the limit matters only for a paid backup model.
Ollama
- Ollama Cloud works today: create a key at ollama.com/settings/keys, choose
Ollama Cloud, and use a model name from ollama.com/api/tags (for example
gemma4:31b). Ollama Cloud is a plan rather than a per-token price: if your plan is flat-rate, enter0as your price under Advanced. - Ollama on your own computer isn't available on the hosted RepoLantern: to our server, "localhost" is the server itself, and private addresses are blocked on purpose.
AWS Bedrock
What you need: a Bedrock API key (simplest), or an access key pair, plus a region and a model or
inference-profile ID.
With a Bedrock API key (recommended):
- In the Bedrock console, pick your region and check the models you want are available to your account.
- Open API keys in the Bedrock console and generate a key. A short-term key (it expires with your console session) is safest; a long-term key lets you set an expiry. Copy it when it is shown.
- On the Model step choose AWS Bedrock, paste it into Bedrock API key, and choose the same Region. RepoLantern accepts these regions: us-east-1, us-east-2, us-west-2, ca-central-1, sa-east-1, eu-west-1, eu-west-3, eu-central-1, ap-south-1, ap-northeast-1, ap-southeast-1 and ap-southeast-2.
- Model: the model ID, or for newer models an inference-profile ID (these start with
us.,eu.orapac.), for exampleus.amazon.nova-micro-v1:0.
A new AWS account may answer "Your account is currently being verified" or "Operation not allowed" until AWS finishes verifying it: RepoLantern pauses and says so; try again once AWS confirms the account.
With an access key pair instead:
- In IAM, create a user just for RepoLantern (no console access) with an inline policy that allows only
bedrock:InvokeModel,bedrock:ListFoundationModels,bedrock:ListInferenceProfilesandbedrock:GetInferenceProfile. - On that user's Security credentials tab, create an access key ("Application running outside AWS").
- On the Model step open Use an access key pair instead and paste both values. The session token is only for temporary credentials.
- Delete the access key when you're done.
Microsoft Foundry
What you need: the endpoint, an API key, and your deployment name.
- Open Microsoft Foundry and open (or create) a project.
- Deploy a model and note the deployment name you gave it: that is the model name in RepoLantern.
- From the resource's Keys and Endpoint, copy the endpoint (
https://<resource>.openai.azure.comorhttps://<resource>.services.ai.azure.com) and one of the keys. - Paste them into Endpoint URL and API key, and type the deployment name as the model.
Web search for release notes (optional)
What you need: a Tavily key.
RepoLantern can search the web for what changed in newer versions of the libraries a repository uses. It needs a
Tavily key: sign up, copy the key (it starts with tvly-) from the overview page, and paste
it under Settings → Web search or on the last step of New guide, then press Test. The free plan gives
1,000 credits a month.
Private repositories
What you need: a read-only access token.
Give a read-only token that can see only the repositories you choose. It is used once to fetch the code and never stored.
- GitHub: Settings → Developer settings → Personal access tokens → Fine-grained tokens → Generate. Under Repository access choose Only select repositories; under permissions set Contents: Read-only. Pick a short expiry.
- GitLab: a project or personal access token with only the read_repository scope.
- Bitbucket: a repository access token (or API token) with Repositories: Read only.
Something isn't working
- Test connection fails: check that the key was copied whole, the model name is exact, and (Bedrock) the region matches the model's region.
- "Paused: model limit": your provider's quota ran out. Resume after the reset time shown, or switch model.
- Price unknown: enter your price under Advanced, or pick a model with a listed price.
- More answers are in Troubleshooting and the FAQ.
With a key ready, make your first guide, or document a repository from the command line.