Problem Statement
Users do not have an easy way to discover all CLI commands and their options, which leads to confusion and slower onboarding.
Proposed Solution
Create a comprehensive CLI command reference section in the documentation, generated from the CLI code itself for accuracy.
Alternative Solutions
Manually update documentation with each release (prone to error).
Feature Category
Documentation
Priority Level
Low - Nice to have
Use Cases
- When onboarding new developers.
- When upgrading to a new version and checking for breaking changes.
- When troubleshooting CLI usage.
Examples
# Example
peezy --help
peezy create --help
Additional Context
Consider leveraging tools like JSDoc or auto-generation scripts to keep this up to date.
Checklist
Problem Statement
Users do not have an easy way to discover all CLI commands and their options, which leads to confusion and slower onboarding.
Proposed Solution
Create a comprehensive CLI command reference section in the documentation, generated from the CLI code itself for accuracy.
Alternative Solutions
Manually update documentation with each release (prone to error).
Feature Category
Documentation
Priority Level
Low - Nice to have
Use Cases
Examples
# Example peezy --help peezy create --helpAdditional Context
Consider leveraging tools like JSDoc or auto-generation scripts to keep this up to date.
Checklist