Skip to content

Conversation

@SL-Mar
Copy link
Owner

@SL-Mar SL-Mar commented Nov 10, 2025

Feature Implementation

Implements the feature request for a built-in --help command to improve CLI usability.

Changes Made

  1. Enhanced Main Help

    • Comprehensive description of QuantCoder's purpose
    • Step-by-step workflow guide (search → list → download → summarize → generate)
    • Practical usage examples
    • Highlights interactive mode for new users
  2. Added --version Flag

    • Shows CLI version (v0.3)
    • Displays OpenAI SDK version (important for v0.28 compatibility)
  3. Improved Command Descriptions

    • Clear parameter explanations
    • Usage examples for each command
    • Prerequisites noted (e.g., "must download first")
    • Consistent formatting across all commands

Example Usage

quantcli --help                  # Main help with workflow
quantcli --version               # Version information
quantcli search --help           # Command-specific help
quantcli generate-code --help    # Another example

Benefits

✅ Improves accessibility for new users
✅ Reduces dependency on external documentation
✅ Self-documenting CLI interface
✅ Shows typical workflow clearly
✅ Backward compatible (no breaking changes)

Testing

All existing commands remain functional. Help text is now comprehensive and informative.

Closes issue requesting --help / -h command functionality.

Features:
- Enhanced main CLI help with workflow guide and examples
- Added --version flag to show CLI and OpenAI SDK versions
- Improved command descriptions with:
  - Clear parameter explanations
  - Practical usage examples
  - Prerequisite notes
  - Consistent formatting

Benefits:
- Improves accessibility for new users
- Self-documenting CLI interface
- No external documentation needed for basic usage
- Shows typical workflow (search → download → generate)

Addresses feature request for built-in help command.
@SL-Mar SL-Mar merged commit ed33fd0 into main Nov 10, 2025
@SL-Mar SL-Mar deleted the feature/enhanced-help-command branch December 15, 2025 14:30
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