A comprehensive AI skill that guides AI agents in properly using the Click Python package for CLI development. This skill provides best practices, patterns, and detailed guidance for building robust command-line interfaces.
click-package
├── SKILL.md # Main skill definition and overview
└── reference/ # Detailed reference documentation
├── click-advanced-groups-context.md
├── click-architecture.md
├── click-callbacks.md
├── click-commands.md
├── click-completion.md
├── click-context.md
├── click-decorators.md
├── click-exceptions.md
├── click-files.md
├── click-formatting.md
├── click-help.md
├── click-info.md
├── click-parameters.md
├── click-parsing.md
├── click-prompts.md
├── click-testing.md
├── click-types.md
├── click-unicode.md
└── click-utilities.md
This skill serves as an expert guide for AI assistants and developers working with Click, covering:
- CLI architecture and design patterns
- Command and group organization
- Parameter handling and validation
- User interaction and file handling
- Testing and error handling
- Advanced Click features
This skill is designed to be used by AI assistants when working with Click-related code. It provides comprehensive guidance for:
- Getting Started: Project setup, dependencies, and entry points
- Commands & Structure: Command organization, groups, and context management
- Parameters & Validation: Options, arguments, types, and callbacks
- User Interaction: Prompts, file handling, and utilities
- Documentation: Help pages, formatting, and shell completion
- Testing & Error Handling: Testing strategies and exception management
- Advanced Topics: Parsing, Unicode support, and extension
- Comprehensive Coverage: 19 detailed reference documents covering all aspects of Click
- Best Practices: Architecture patterns and CLI design guidelines
- Practical Examples: Real-world usage patterns and code examples
- Testing Guidance: Complete testing strategies with CliRunner
- Error Handling: Robust exception handling and exit code management
The skill includes detailed condensed reference documentation for every Click feature and best practices, using progressive disclosure for efficiency.
click-info.md- Click overview and conceptsclick-architecture.md- Project structure and design patternsclick-commands.md- Commands and groupsclick-parameters.md- Options, arguments, and validationclick-testing.md- Testing with CliRunnerclick-context.md- Context object usageclick-types.md- Built-in and custom typesclick-callbacks.md- Validation and callbacksclick-prompts.md- User input and interactionclick-files.md- File handling and I/Oclick-utilities.md- Output, colors, and progress barsclick-help.md- Documentation and help pagesclick-formatting.md- Custom help formattingclick-completion.md- Shell completionclick-exceptions.md- Error handling and exit codesclick-parsing.md- Command parsingclick-unicode.md- Unicode supportclick-decorators.md- Common decorators and shortcutsclick-advanced-groups-context.md- Nested commands and shared state
This skill is designed to be consumed by AI assistants to provide expert guidance on Click development. When working with Click-related code, the AI should:
- Reference the appropriate documentation based on the specific task
- Follow best practices outlined in the architecture guide
- Implement proper testing using the testing guidelines
- Handle errors appropriately using the exception handling patterns
- Provide comprehensive help and documentation for CLI tools
For developers new to Click, the skill provides guidance on:
- Setting up virtual environments
- Adding Click to project dependencies
- Creating package entry points
- Following architectural best practices
- Implementing proper testing strategies
Contributions to improve the guidance, add new patterns, or update for newer Click versions are welcome.
MIT. Enjoy 🎉