Enhance CLI help system with comprehensive documentation and examples #1257
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit significantly improves the discoverability and usability of the LLM CLI by adding comprehensive help documentation to all major commands. ## Key Improvements - **Enhanced main CLI help** with emoji-organized quick start, common tasks, and setup sections - **Comprehensive command documentation** with practical examples and use cases - **Official documentation links** integrated throughout help text - **Progressive examples** from basic to advanced usage patterns - **Parameter explanations** with context on when and why to use each option - **Security guidance** built into help text for sensitive operations ## Commands Enhanced - `llm prompt` - Detailed examples for basic usage, file analysis, tools, conversations - `llm chat` - Interactive commands, tool usage, conversation management - `llm models` - Model discovery, configuration, and search patterns - `llm keys` - Secure API key management with provider-specific guidance - `llm templates` - Template creation and usage workflows - `llm tools` - Tool capabilities and security considerations - `llm embed` - Semantic search concepts and collection management ## User Experience Improvements - **Immediate usability** - Users can learn full capabilities without external docs - **Copy-paste examples** - All examples are immediately runnable - **Context-aware help** - Explains when and why to use each feature - **AI-friendly** - Rich documentation makes CLI more discoverable for AI assistants - **Progressive learning** - From beginner to expert usage patterns The CLI now serves as a comprehensive self-documenting reference while maintaining easy access to detailed online documentation when needed. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
Enhances help text for all remaining commands with detailed usage examples, official documentation links, and fetch tool guidance. ## Additional Commands Enhanced - **aliases** - Model shortcut management with practical examples - **logs** - Conversation history and privacy controls - **fragments** - Text snippet storage and reuse patterns - **schemas** - Structured output format definitions - **collections** - Embedding organization for semantic search - **similar** - Semantic similarity search with advanced options - **plugins** - Plugin discovery and capability inspection ## Key Additions - **Fetch tool guidance** in main CLI help for AI assistants - **Progressive examples** from basic to advanced usage - **Security notes** where appropriate - **Official documentation links** for every command - **Context explanations** for when and why to use features This completes the comprehensive CLI documentation enhancement, making every command self-documenting while maintaining easy access to detailed online guides. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
- Root help: add default-subcommand note; remove irrelevant fetch note - Add 'Defaults to list' note to DefaultGroup commands (keys, logs, models, templates, schemas, tools, aliases, fragments, embed-models, collections, models options) - Add clear examples, tips, and official doc links across commands - Improve embed-multi, plugins, schemas dsl, templates/fragments loaders, models options set, logs list - Tighten keys get/path phrasing and add links This makes the CLI self-discoverable and consistent.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
vibe documented better docs