Skip to content

Commit 4d479b6

Browse files
scastlarascastlara
authored
docs: more doc adjustments to readme (#111)
1 parent e80ff59 commit 4d479b6

File tree

1 file changed

+29
-16
lines changed

1 file changed

+29
-16
lines changed

‎README.md‎

Lines changed: 29 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ lgtm-ai is your AI-powered code review companion. It generates code reviews usin
2424
- [Supported Code Repository Services](#supported-code-repository-services)
2525
- [Using Issue/User Story Information](#using-issueuser-story-information)
2626
- [Supported AI models](#supported-ai-models)
27+
- [Summary](#summary)
2728
- [OpenAI](#openai)
2829
- [Google Gemini](#google-gemini)
2930
- [Anthropic's Claude](#anthropics-claude)
@@ -106,7 +107,7 @@ Reviews generated by lgtm will be assigned a **score**, using the following scal
106107
| Needs a Lot of Work 🚨 | Issues are major, overarching, and/or numerous. However, the approach taken is not necessarily wrong. |
107108
| Abandon ❌ | The approach taken is wrong, and the author needs to start from scratch. The PR is not ready to be merged as is at all. |
108109

109-
For each review, lgtm may create several inline comments, pointing out specific issues within the PR. These comments belong to a **category** and have a **severity**. You can configure which categories you want lgtm to take a look at (see the [configuration section below](./README.md#configuration-file)). The available categories are:
110+
For each review, lgtm may create several inline comments, pointing out specific issues within the PR. These comments belong to a **category** and have a **severity**. You can configure which categories you want lgtm to take a look at (see the [configuration section below](#configuration)). The available categories are:
110111

111112
| Category | Description |
112113
| ------- | ----------- |
@@ -170,6 +171,18 @@ lgtm supports several AI models so you can hook up your preferred LLM to perform
170171

171172
This is the full list of supported models:
172173

174+
#### Summary
175+
176+
| Provider | Example Models | API Key Setup |
177+
|-------------|---------------------------------|-------------------------------------------------------------------------------|
178+
| **OpenAI** | `gpt-5`, `gpt-4.1`, `gpt-4o-mini`, `o1-preview` | [Generate API key](https://platform.openai.com/api-keys) |
179+
| **Google Gemini** | `gemini-2.5-pro`, `gemini-2.5-flash` | [Get API key](https://aistudio.google.com/apikey) |
180+
| **Anthropic (Claude)** | `claude-3.5-sonnet-latest`, `claude-3-opus-latest` | [Anthropic Console](https://console.anthropic.com/dashboard) |
181+
| **Mistral** | `mistral-large-latest`, `mistral-small`, `codestral-latest` | [Mistral Platform](https://console.mistral.ai/api-keys) |
182+
| **DeepSeek** | `deepseek-chat`, `deepseek-reasoner` | [DeepSeek Platform](https://platform.deepseek.com/usage) |
183+
| **Local / Custom** | Any OpenAI-compatible model (e.g. `llama3`) | Run with `--model-url http://localhost:11434/v1` |
184+
185+
173186
#### OpenAI
174187

175188
Check out the OpenAI platform page to see [all available models provided by OpenAI](https://platform.openai.com/docs/overview).
@@ -271,7 +284,7 @@ These are the main supported models, though the CLI may support additional ones
271284
| ------------------ |
272285
| mistral-large-latest |
273286
| mistral-small |
274-
| codestrallatest |
287+
| codestral-latest |
275288

276289
</details>
277290

@@ -361,19 +374,19 @@ When it comes to preference for selecting options, lgtm follows this preference
361374

362375
| Option | Feature Group | Optionality | Notes/Conditions |
363376
|----------------------|----------------------|---------------------|---------------------------------------------------------------------------------|
364-
| model | Main (review/guide) | 🔴 Required* | AI model to use. Defaults to `gpt-4.1` if not set. |
365-
| model_url | Main (review/guide) | 🟢 Optional | Only needed for custom/local models. |
366-
| exclude | Main (review/guide) | 🟢 Optional | File patterns to exclude from review. |
367-
| publish | Main (review/guide) | 🟢 Optional | If true, posts review as comments. Default: false. |
368-
| output_format | Main (review/guide) | 🟢 Optional | `pretty` (default), `json`, or `markdown`. |
369-
| silent | Main (review/guide) | 🟢 Optional | Suppress terminal output. Default: false. |
370-
| ai_retries | Main (review/guide) | 🟢 Optional | Number of retries for AI agent queries. Default: 1. |
371-
| ai_input_tokens_limit| Main (review/guide) | 🟢 Optional | Max input tokens for LLM. Default: 500,000. Use `"no-limit"` to disable. |
372-
| git_api_key | Main (review/guide) | 🔴 Required* | API key for git service (GitHub/GitLab). Can't be given through config file. Also available through env variable `LGTM_GIT_API_KEY`. |
373-
| ai_api_key | Main (review/guide) | 🔴 Required* | API key for AI model. Can't be given through config file. Also available through env variable `LGTM_AI_API_KEY`. |
374-
| technologies | Main (review) | 🟢 Optional | List of technologies for reviewer expertise. |
375-
| categories | Main (review) | 🟢 Optional | Review categories. Defaults to all (`Quality`, `Correctness`, `Testing`, `Security`). |
376-
| additional_context | Main (review) | 🟢 Optional | Extra context for the LLM (array of prompts/paths/URLs). Can't be given through the CLI |
377+
| model | Main (review + guide) | 🟢 Optional | AI model to use. Defaults to `gpt-4.1` if not set. |
378+
| model_url | Main (review + guide) | 🟡 Conditionally required | Only needed for custom/local models. |
379+
| exclude | Main (review + guide) | 🟢 Optional | File patterns to exclude from review. |
380+
| publish | Main (review + guide) | 🟢 Optional | If true, posts review as comments. Default: false. |
381+
| output_format | Main (review + guide) | 🟢 Optional | `pretty` (default), `json`, or `markdown`. |
382+
| silent | Main (review + guide) | 🟢 Optional | Suppress terminal output. Default: false. |
383+
| ai_retries | Main (review + guide) | 🟢 Optional | Number of retries for AI agent queries. Default: 1. |
384+
| ai_input_tokens_limit| Main (review + guide) | 🟢 Optional | Max input tokens for LLM. Default: 500,000. Use `"no-limit"` to disable. |
385+
| git_api_key | Main (review + guide) | 🔴 Required* | API key for git service (GitHub/GitLab). Can't be given through config file. Also available through env variable `LGTM_GIT_API_KEY`. |
386+
| ai_api_key | Main (review + guide) | 🔴 Required* | API key for AI model. Can't be given through config file. Also available through env variable `LGTM_AI_API_KEY`. |
387+
| technologies | Review Only | 🟢 Optional | List of technologies for reviewer expertise. |
388+
| categories | Review Only | 🟢 Optional | Review categories. Defaults to all (`Quality`, `Correctness`, `Testing`, `Security`). |
389+
| additional_context | Review Only | 🟢 Optional | Extra context for the LLM (array of prompts/paths/URLs). Can't be given through the CLI |
377390
| issues_url | Issues Integration | 🟢 Optional | Enables issue context. If set, `issues_source` becomes required. |
378391
| issues_source | Issues Integration | 🟡 Conditionally required | Required if `issues_url` is set. |
379392
| issues_regex | Issues Integration | 🟢 Optional | Regex for issue ID extraction. Defaults to conventional commit compatible regex. |
@@ -411,7 +424,7 @@ See [Using Issue/User Story Information section](#using-issueuser-story-informat
411424
- **issues_url**: The base URL of the issues or user story page to fetch additional context for the PR. If set, `issues_source` becomes required.
412425
- **issues_source**: The platform for the issues (e.g., `github`, `gitlab`). Required if `issues_url` is set.
413426
- **issues_regex**: A regex pattern to extract the issue ID from the PR title or description. If omitted, lgtm uses a default regex compatible with conventional commits and common PR formats.
414-
- **issues_api_key**: API key for the issues service (if different from `git_api_key`).
427+
- **issues_api_key**: API key for the issues service (if different from `git_api_key`). Can be given as a CLI argument, or as an environment variable (`LGTM_ISSUES_API_KEY`).
415428

416429
#### Example `lgtm.toml`
417430

0 commit comments

Comments
 (0)