Skip to content

Conversation

@cardmagic
Copy link
Owner

  • Remove classify subcommand (it's the default action)
  • Remove ! from examples (causes shell issues)
  • Put -r model flag before text argument

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Jan 1, 2026

Greptile Summary

Simplified CLI documentation examples by removing the redundant classify subcommand (it's the default action), fixing flag order to put -r model before text arguments, and removing ! from examples to avoid shell escaping issues.

  • Verified that classify is indeed the default action in lib/classifier/cli.rb:183
  • Flag reordering is correct since OptionParser processes flags before positional arguments
  • Changed contraction "I'm" to "I am" for consistency

Confidence Score: 5/5

  • This PR is safe to merge with no risk - documentation-only changes that accurately reflect existing CLI behavior
  • Score reflects that this is a simple documentation cleanup with no code changes. All example updates were verified against the actual CLI implementation in cli.rb to ensure accuracy. The changes improve user experience by simplifying examples and avoiding shell escaping issues.
  • No files require special attention

Important Files Changed

Filename Overview
README.md Simplified CLI examples by removing redundant classify command and fixing flag ordering - documentation now matches actual CLI behavior

Sequence Diagram

sequenceDiagram
    participant User
    participant CLI as classifier CLI
    participant OptionParser
    participant CommandExecutor

    User->>CLI: classifier -r model "text"
    CLI->>OptionParser: parse_options()
    OptionParser->>OptionParser: Extract -r flag value
    OptionParser->>CLI: Set @options[:remote] = "model"
    CLI->>CommandExecutor: execute_command()
    CommandExecutor->>CommandExecutor: Check command (no recognized command)
    CommandExecutor->>CommandExecutor: command_classify() [default action]
    CommandExecutor->>User: classification result
Loading

@cardmagic cardmagic merged commit 3c56a91 into master Jan 1, 2026
6 checks passed
@cardmagic cardmagic deleted the update-cli-examples branch January 1, 2026 19:09
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.

2 participants