Update README.md for CLI accuracy and supported agents#169
Update README.md for CLI accuracy and supported agents#169yacosta738 wants to merge 1 commit intomainfrom
Conversation
Updated the Usage section in README.md to include missing but essential CLI flags for init, apply, clean, status, doctor, and skill commands. These changes ensure the documentation accurately reflects the current CLI implementation as verified against the codebase. Co-authored-by: yacosta738 <33158051+yacosta738@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
|
Hey there and thank you for opening this pull request! We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted. Details: |
📝 WalkthroughSummary by CodeRabbit
WalkthroughUpdates README documentation to introduce optional path-targeting and configuration flags across CLI commands including init, apply, clean, status, doctor, and skill operations. Consolidates skill command syntax and adds new options for verbosity, filtering, and JSON output formatting. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
✅ Contributor ReportUser: @yacosta738
Contributor Report evaluates based on public GitHub activity. Analysis period: 2025-02-11 to 2026-02-11 |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
202-235: 🧹 Nitpick | 🔵 TrivialThe flag naming difference is intentional and correctly documented; consider adding clarification about the semantic distinction.
The documentation accurately reflects the implementation:
init,apply, andcleancommands use--path(with-pshort flag), whilestatus,doctor, andskillcommands use--project-root. This appears to be deliberate—configuration-modification commands use--path, while inspection/status commands use--project-root. Adding a note explaining this semantic distinction would improve clarity for users.
I have reviewed the codebase and updated the
README.mdto ensure it accurately reflects the current state of the CLI.Key changes include:
agentsync initusage to include[--path <path>]and[--force].agentsync applyandcleanusage to include missing configuration flags.agentsync doctorusage to include[--project-root <path>].agentsync statususage for consistency.agentsync skillsubcommands to include[--project-root <path>],[--source <source>], and[--json].These changes were verified against the actual CLI implementation in
src/main.rsand relevant command modules. All tests passed.PR created automatically by Jules for task 9759776773187079799 started by @yacosta738