Skip to content

Update README of CLI#14

Merged
yu-iskw merged 1 commit intomainfrom
readme-2
Feb 6, 2026
Merged

Update README of CLI#14
yu-iskw merged 1 commit intomainfrom
readme-2

Conversation

@yu-iskw
Copy link
Owner

@yu-iskw yu-iskw commented Feb 6, 2026

PR Type

Documentation


Description

  • Expanded CLI README with comprehensive command documentation

  • Added installation methods including global and npx options

  • Documented all command categories: Rules, Skills, Subagents, Plugins, System

  • Added detailed global and command-specific options documentation

  • Bumped package version from 0.1.1 to 0.1.2


Diagram Walkthrough

flowchart LR
  A["CLI README"] -->|Add Installation Methods| B["Global + npx"]
  A -->|Expand Usage Examples| C["Rules, Skills, Subagents"]
  A -->|Document Commands| D["Rules, Skills, Subagents, Plugins, System"]
  A -->|Add Options| E["Global and Command-specific Options"]
  F["package.json"] -->|Version Bump| G["0.1.1 to 0.1.2"]
Loading

File Walkthrough

Relevant files
Documentation
README.md
Comprehensive CLI documentation expansion                               

packages/cli/README.md

  • Added installation instructions for both global and npx methods
  • Expanded usage examples with new commands like caf rules, caf doctor,
    and caf update
  • Reorganized and documented all command categories with descriptions
  • Added comprehensive global options and command-specific options
    sections
  • Introduced new command categories: Rules, Plugins, and System
    management
+78/-14 
Configuration changes
package.json
Version bump for CLI release                                                         

package.json

  • Updated version from 0.1.1 to 0.1.2
+1/-1     

Signed-off-by: Yu Ishikawa <yu-iskw@users.noreply.github.com>
@yu-iskw yu-iskw marked this pull request as ready for review February 6, 2026 02:08
@yu-iskw yu-iskw merged commit 95c5ea2 into main Feb 6, 2026
5 checks passed
@qodo-code-review
Copy link

ⓘ You are approaching your monthly quota for Qodo. Upgrade your plan

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢
No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
🎫 No ticket provided
  • Create ticket/issue
Codebase Duplication Compliance
Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance
🟢
Generic: Comprehensive Audit Trails

Objective: To create a detailed and reliable record of critical system actions for security analysis
and compliance.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Meaningful Naming and Self-Documenting Code

Objective: Ensure all identifiers clearly express their purpose and intent, making code
self-documenting

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Robust Error Handling and Edge Case Management

Objective: Ensure comprehensive error handling that provides meaningful context and graceful
degradation

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Error Handling

Objective: To prevent the leakage of sensitive system information through error messages while
providing sufficient detail for internal debugging.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Logging Practices

Objective: To ensure logs are useful for debugging and auditing without exposing sensitive
information like PII, PHI, or cardholder data.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Security-First Input Validation and Data Handling

Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent
vulnerabilities

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Compliance status legend 🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

@qodo-code-review
Copy link

ⓘ You are approaching your monthly quota for Qodo. Upgrade your plan

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Clarify and consolidate update check commands

Remove the redundant caf check command from the documentation and instead
explain that caf update --check-only should be used to check for updates.

packages/cli/README.md [86-87]

-- `caf check` - Check for updates across all resources
-- `caf update` - Update all resources to their latest versions
+- `caf update` - Update all resources to their latest versions. Use `--check-only` to check for updates without installing.
  • Apply / Chat
Suggestion importance[1-10]: 6

__

Why: The suggestion correctly identifies a redundancy between caf check and caf update --check-only, and proposing to consolidate them improves the CLI's usability and documentation clarity.

Low
Clarify the behavior of force remove

Clarify the description of the --force flag for the remove command to state that
it suppresses errors if the resource is not found.

packages/cli/README.md [113]

-- `-f, --force` - Force removal even if the resource is not found
+- `-f, --force` - Suppress error and exit successfully if the resource is not found
  • Apply / Chat
Suggestion importance[1-10]: 4

__

Why: The suggestion improves documentation clarity by rephrasing the purpose of the --force flag to more accurately describe its likely idempotent behavior.

Low
  • More

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