ti.sil/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-12-11 18:35:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: improve formatting and fix typos in Qodo Merge CLI documentation

Browse source
This commit is contained in:
Hussam.lawen 2025-09-15 17:32:15 +03:00
parent 60948ac3c8
commit 0ee6ee6e7d
No known key found for this signature in database
GPG key ID: 07E08C11EA208BC2
3 changed files with 16 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/docs/qodo-merge-cli/index.md
View file

@ -11,7 +11,7 @@ The CLI can bridge the gap between Qodo Merge feedback and code implementation i
- **Seamlessly generating and managing PR suggestions** without context switching - **Seamlessly generating and managing PR suggestions** without context switching
- Remote Suggestions: Fetches Qodo Merge suggestions from your Git Environment - Remote Suggestions: Fetches Qodo Merge suggestions from your Git Environment
- Local Suggestions: Get real-time suggestion against your local changes - Local Suggestions: Get real-time suggestions against your local changes
- **Interactive review and implementation** of AI feedback directly in your terminal - **Interactive review and implementation** of AI feedback directly in your terminal
- **Tracking implementation status** of each suggestion (pending/implemented/declined) - **Tracking implementation status** of each suggestion (pending/implemented/declined)

4
docs/docs/qodo-merge-cli/installation.md
View file

@ -21,8 +21,8 @@ To start using Qodo Command, you need to log in first:
qodo login qodo login
``` ```
Once login is completed you'll receive an API key in the terminal. Once login is completed, you'll receive an API key in the terminal.
The API key is also saved locally in the .qodo folder in your home dir, and can be reuused (e.g., in CI). The API key is also saved locally in the .qodo folder in your home directory, and can be reused (e.g., in CI).
The key is tied to your user account and subject to the same usage limits. The key is tied to your user account and subject to the same usage limits.
[//]: # (## API Key Management) [//]: # (## API Key Management)

26
docs/docs/qodo-merge-cli/usage.md
View file

@ -17,7 +17,7 @@ This consistent user-friendly structure streamlines the review process, reducing
### Navigation instructions ### Navigation Instructions
Use `↑`/`↓` to navigate suggestions, `Enter` to implement, `Space` for multi-select, and `ESC` to exit. Use `↑`/`↓` to navigate suggestions, `Enter` to implement, `Space` for multi-select, and `ESC` to exit.
The table includes: The table includes:
@ -67,7 +67,7 @@ You can view the proposed code changes in a diff format, jump to the relevant co
=== "Side-by-Side View (`S`)" === "Side-by-Side View (`S`)"
![Side by Side Diff](https://www.qodo.ai/images/pr_agent/qm_cli_side_by_side_diffview.png){width=768} ![Side-by-Side Diff](https://www.qodo.ai/images/pr_agent/qm_cli_side_by_side_diffview.png){width=768}
- Press `S` for side-by-side diff view - Press `S` for side-by-side diff view
- Enhanced layout for complex changes - Enhanced layout for complex changes
@ -114,7 +114,7 @@ You can implement a single suggestion, multiple selected suggestions, or all sug
**Select multiple related suggestions** **Select multiple related suggestions**
1. Use Space to select specific suggestions (◉) 1. Use `Space` to select specific suggestions (◉)
2. Navigate and select multiple related suggestions 2. Navigate and select multiple related suggestions
3. Press `Enter` on any selected suggestion to start implementation 3. Press `Enter` on any selected suggestion to start implementation
4. AI implements selected suggestions together 4. AI implements selected suggestions together
@ -135,7 +135,7 @@ You can implement a single suggestion, multiple selected suggestions, or all sug
**Discuss then implement** **Discuss then implement**
1. Press C on any suggestion to start chat 1. Press `C` on any suggestion to start a chat
2. Ask questions, request modifications, get clarifications 2. Ask questions, request modifications, get clarifications
3. Once satisfied, request implementation via chat 3. Once satisfied, request implementation via chat
4. AI implements based on your discussion 4. AI implements based on your discussion
@ -177,9 +177,9 @@ After implementing the suggestions, you have several options to proceed:
Discuss the implementation details: Discuss the implementation details:
- Review changes made by the AI - Review changes made by the AI
- Request refinements or modifications - Request refinements or modifications
- Get explanations of implementation approach - Get explanations of implementation approach
- Continuous improvement cycle - Continuous improvement cycle
=== "Commit Changes (`M`)" === "Commit Changes (`M`)"
@ -188,18 +188,18 @@ After implementing the suggestions, you have several options to proceed:
Auto-generate commit messages: Auto-generate commit messages:
- AI-generated commit messages based on changes - AI-generated commit messages based on changes
- Editable before committing - Editable before committing
- Standard git conventions - Standard git conventions
- Seamless workflow integration - Seamless workflow integration
=== "Open Edited File (`O`)" === "Open Edited File (`O`)"
Open the implemented code directly in your IDE: Open the implemented code directly in your IDE:
- View the exact changes made - View the exact changes made
- See implementation in full context - See implementation in full context
- Continue development seamlessly - Continue development seamlessly
- Integrated with your existing workflow - Integrated with your existing workflow
## Tips for Success ## Tips for Success