Skip to content

Comments

Update README.md for CLI accuracy and supported agents#169

Draft
yacosta738 wants to merge 1 commit intomainfrom
docs-update-readme-cli-accuracy-9759776773187079799
Draft

Update README.md for CLI accuracy and supported agents#169
yacosta738 wants to merge 1 commit intomainfrom
docs-update-readme-cli-accuracy-9759776773187079799

Conversation

@yacosta738
Copy link
Contributor

I have reviewed the codebase and updated the README.md to ensure it accurately reflects the current state of the CLI.

Key changes include:

  • Updated agentsync init usage to include [--path <path>] and [--force].
  • Updated agentsync apply and clean usage to include missing configuration flags.
  • Updated agentsync doctor usage to include [--project-root <path>].
  • Updated agentsync status usage for consistency.
  • Updated agentsync skill subcommands to include [--project-root <path>], [--source <source>], and [--json].

These changes were verified against the actual CLI implementation in src/main.rs and relevant command modules. All tests passed.


PR created automatically by Jules for task 9759776773187079799 started by @yacosta738

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>
@google-labs-jules
Copy link
Contributor

👋 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 @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@github-actions
Copy link

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:

No release type found in pull request title "Update README.md for CLI accuracy and supported agents". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 11, 2026

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Updated CLI command documentation with new optional flags for enhanced customization, including path targeting, configuration options, and filtering capabilities across initialization, application, cleaning, status, diagnostics, and skill management commands.

Walkthrough

Updates 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

Cohort / File(s) Summary
CLI Command Documentation
README.md
Adds optional flags (--path, --force, --config, --project-root, --json, --source) to multiple CLI commands and consolidates skill command syntax with enhanced options.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 With flags now dancing, so many and bright,
Each command grows stronger, more tailored and right,
The README now shimmers with options galore,
Path-targeting powers we never had before! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the main change: updating README.md to document current CLI functionality with proper flags and agent support.
Description check ✅ Passed The description is directly related to the changeset, detailing specific CLI command updates and verification against the implementation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs-update-readme-cli-accuracy-9759776773187079799

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link

✅ Contributor Report

User: @yacosta738
Status: Passed (12/13 metrics passed)

Metric Description Value Threshold Status
PR Merge Rate PRs merged vs closed 89% >= 30%
Repo Quality Repos with ≥100 stars 0 >= 0
Positive Reactions Positive reactions received 9 >= 1
Negative Reactions Negative reactions received 0 <= 5
Account Age GitHub account age 3029 days >= 30 days
Activity Consistency Regular activity over time 108% >= 0%
Issue Engagement Issues with community engagement 0 >= 0
Code Reviews Code reviews given to others 344 >= 0
Merger Diversity Unique maintainers who merged PRs 3 >= 0
Repo History Merge Rate Merge rate in this repo 0.8108108108108109 >= 0
Repo History Min PRs Previous PRs in this repo 76 >= 0
Profile Completeness Profile richness (bio, followers) 90 >= 0
Suspicious Patterns Spam-like activity detection 1 N/A

Contributor Report evaluates based on public GitHub activity. Analysis period: 2025-02-11 to 2026-02-11

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 | 🔵 Trivial

The flag naming difference is intentional and correctly documented; consider adding clarification about the semantic distinction.

The documentation accurately reflects the implementation: init, apply, and clean commands use --path (with -p short flag), while status, doctor, and skill commands 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant