Skip to content

[ef-44] fix: correct CLI commands in README#45

Merged
NiveditJain merged 4 commits into
mainfrom
ef-44/fix-readme-cli-commands
Apr 8, 2026
Merged

[ef-44] fix: correct CLI commands in README#45
NiveditJain merged 4 commits into
mainfrom
ef-44/fix-readme-cli-commands

Conversation

@yashexosphere

@yashexosphere yashexosphere commented Apr 8, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Fixed 9 incorrect CLI commands in README.md that used non-existent flat-flag style (--install-policies, --remove-policies, --list-policies)
  • Updated all occurrences to match actual subcommand syntax (policies --install, policies --uninstall, policies)
  • Affected sections: Quick Start, Policy Installation (scopes table + examples), and Custom Policies

Closes #44

Test plan

  • Verify all README commands match failproofai --help output
  • Run each documented command to confirm it works

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated CLI examples for policy management to use subcommand syntax (e.g., failproofai policies --install, failproofai policies --uninstall) instead of legacy flag-style invocations.
    • All scope-specific examples (global/project/local), installation/removal of named policies, and the custom policy install example were updated to the new form.
    • No other README content was changed.

The README used non-existent flat-flag style commands
(--install-policies, --remove-policies, --list-policies).
Updated all 9 occurrences to match the actual subcommand
syntax (policies --install, policies --uninstall, policies).

Yash Upadhyay <yashupadhyayy1@gmail.com>
Co-Authored-By: Claude <noreply@anthropic.com>
@yashexosphere yashexosphere linked an issue Apr 8, 2026 that may be closed by this pull request
@coderabbitai

coderabbitai Bot commented Apr 8, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2300eb0a-d1ec-4cab-872c-3024ad4556b6

📥 Commits

Reviewing files that changed from the base of the PR and between 954b8c8 and 7b12bb2.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

📝 Walkthrough

Walkthrough

Updated nine CLI examples in README.md to use the policies subcommand form instead of legacy top-level flags (e.g., failproofai policies --install / failproofai policies / failproofai policies --uninstall); no other content or functionality statements were changed.

Changes

Cohort / File(s) Summary
Documentation
README.md
Replaced 9 flag-style policy CLI examples (--install-policies, --remove-policies, --list-policies) with failproofai policies subcommand forms (--install, --uninstall, or no subcommand to list). Changes span Quick Start, Policy Installation, and Custom Policies sections. No functional changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 I hopped through README, fixed each stray flag,
Turned scattered dashes into a tidy subtag.
Commands now align, neat as a trail,
Policies parade without fail.
A rabbit’s nibble made docs less ragged.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely identifies the main change: correcting CLI commands in the README to match actual syntax.
Description check ✅ Passed The description provides clear details about what was fixed and includes references to the issue and test plan, though it lacks the formal template sections.
Linked Issues check ✅ Passed All 9 CLI command corrections specified in issue #44 have been implemented: flat-flag forms replaced with proper subcommand syntax across all affected sections.
Out of Scope Changes check ✅ Passed Only README.md documentation changes present; all changes directly address the linked issue #44 objectives with no extraneous modifications.
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
  • Commit unit tests in branch ef-44/fix-readme-cli-commands

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.

@NiveditJain NiveditJain merged commit d8cf172 into main Apr 8, 2026
8 checks passed
@NiveditJain NiveditJain deleted the ef-44/fix-readme-cli-commands branch April 27, 2026 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix: README CLI commands don't match actual CLI syntax

2 participants