pr-agent/docs/docs/tools/analyze.md

24 lines
819 B
Markdown
Raw Normal View History

2024-03-06 19:52:11 +00:00
## Overview
2023-12-24 11:08:13 +00:00
The `analyze` tool combines static code analysis with LLM capabilities to provide a comprehensive analysis of the PR code changes.
The tool scans the PR code changes, find the code components (methods, functions, classes) that changed, and summarizes the changes in each component.
It can be invoked manually by commenting on any PR:
```
/analyze
```
2024-03-06 19:52:11 +00:00
## Example usage
2023-12-24 11:08:13 +00:00
An example [result](https://github.com/Codium-ai/pr-agent/pull/546#issuecomment-1868524805):
<kbd><img src=https://codium.ai/images/pr_agent/analyze_1.png width="768"></kbd>
2024-03-06 19:52:11 +00:00
2023-12-24 11:08:13 +00:00
<kbd><img src=https://codium.ai/images/pr_agent/analyze_2.png width="768"></kbd>
2024-03-06 19:52:11 +00:00
2023-12-24 11:08:13 +00:00
<kbd><img src=https://codium.ai/images/pr_agent/analyze_3.png width="768"></kbd>
2024-03-06 19:52:11 +00:00
**Notes**
2023-12-24 11:08:13 +00:00
- Language that are currently supported: Python, Java, C++, JavaScript, TypeScript.