Skip to content

[Feature]: Add CLI command reference to documentation #20

Description

@Sehnya

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

  1. When onboarding new developers.
  2. When upgrading to a new version and checking for breaking changes.
  3. 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

  • I have searched existing issues to ensure this is not a duplicate
  • I have provided a clear problem statement and proposed solution
  • This feature aligns with Peezy CLI's goals of simplifying project initialization

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions