docs: add update advice to README and CLI#85
Conversation
- README: Note that npm suppresses postinstall output, advise running aidevops update - CLI: Show warning when agents version doesn't match CLI version
WalkthroughChanges add version consistency checks and deployment reminders to ensure CLI and installed agents remain synchronized. README documentation now instructs users to run Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧹 Recent nitpick comments
|
Summary of ChangesHello @marcusquinn, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses a user experience issue where important post-installation instructions for the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
🔍 Code Quality Report�[0;35m[MONITOR]�[0m Code Review Monitoring Report �[0;34m[INFO]�[0m Latest Quality Status: �[0;34m[INFO]�[0m Recent monitoring activity: 📈 Current Quality Metrics
Generated on: Wed Jan 14 03:01:35 UTC 2026 Generated by AI DevOps Framework Code Review Monitoring |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request improves the user experience by adding advice to run aidevops update after installation. The README is updated with this instruction for npm and bun, and a warning is added to the CLI to notify users of version mismatches between the CLI and the agents. The changes are clear and address an important usability issue. I've suggested a small refactoring in aidevops.sh to improve the structure of the new version check logic.
| if [[ "$command" != "update" && "$command" != "upgrade" && "$command" != "u" ]]; then | ||
| local cli_version agents_version | ||
| cli_version=$(get_version) | ||
| if [[ -f "$AGENTS_DIR/VERSION" ]]; then | ||
| agents_version=$(cat "$AGENTS_DIR/VERSION") | ||
| else | ||
| agents_version="not installed" | ||
| fi | ||
|
|
||
| if [[ "$agents_version" == "not installed" ]]; then | ||
| echo -e "${YELLOW}[WARN]${NC} Agents not installed. Run: aidevops update" | ||
| echo "" | ||
| elif [[ "$cli_version" != "$agents_version" ]]; then | ||
| echo -e "${YELLOW}[WARN]${NC} Version mismatch - CLI: $cli_version, Agents: $agents_version" | ||
| echo -e " Run: aidevops update" | ||
| echo "" | ||
| fi | ||
| fi |
There was a problem hiding this comment.
The logic for checking agent versions can be slightly refactored for clarity and efficiency. By first checking if the agents are installed, you can avoid unnecessarily fetching the CLI version if they aren't. This also makes the logic more direct.
| if [[ "$command" != "update" && "$command" != "upgrade" && "$command" != "u" ]]; then | |
| local cli_version agents_version | |
| cli_version=$(get_version) | |
| if [[ -f "$AGENTS_DIR/VERSION" ]]; then | |
| agents_version=$(cat "$AGENTS_DIR/VERSION") | |
| else | |
| agents_version="not installed" | |
| fi | |
| if [[ "$agents_version" == "not installed" ]]; then | |
| echo -e "${YELLOW}[WARN]${NC} Agents not installed. Run: aidevops update" | |
| echo "" | |
| elif [[ "$cli_version" != "$agents_version" ]]; then | |
| echo -e "${YELLOW}[WARN]${NC} Version mismatch - CLI: $cli_version, Agents: $agents_version" | |
| echo -e " Run: aidevops update" | |
| echo "" | |
| fi | |
| fi | |
| if [[ "$command" != "update" && "$command" != "upgrade" && "$command" != "u" ]]; then | |
| if [[ ! -f "$AGENTS_DIR/VERSION" ]]; then | |
| echo -e "${YELLOW}[WARN]${NC} Agents not installed. Run: aidevops update" | |
| echo "" | |
| else | |
| local cli_version agents_version | |
| cli_version=$(get_version) | |
| agents_version=$(cat "$AGENTS_DIR/VERSION") | |
| if [[ "$cli_version" != "$agents_version" ]]; then | |
| echo -e "${YELLOW}[WARN]${NC} Version mismatch - CLI: $cli_version, Agents: $agents_version" | |
| echo -e " Run: aidevops update" | |
| echo "" | |
| fi | |
| fi | |
| fi |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
🤖 Augment PR SummarySummary: Improves post-install guidance so users don’t miss the required agents deployment step. 🤖 Was this summary useful? React with 👍 or 👎 |
![augmentcode[bot]](https://avatars.githubusercontent.com/in/1027498?s=60&v=4){kind=small}
| echo "" | ||
| fi | ||
|
|
||
| # Check if agents need updating (skip for update command itself) |
There was a problem hiding this comment.
Note this warning runs for all commands except update/upgrade/u (including version/--version and help), which can be a breaking change if anyone parses those outputs in scripts.
🤖 Was this useful? React with 👍 or 👎
1 participant
Summary
aidevops updateWhy
npm v7+ suppresses lifecycle script output, so users don't see the postinstall message advising them to run
aidevops update. This PR:Example
Summary by CodeRabbit
Documentation
New Features
✏️ Tip: You can customize this high-level summary in your review settings.