Skip to content

[FEAT] Component Listing Feature #43

@binit2-1

Description

@binit2-1

Is your feature request related to a problem? Please describe.
Currently, the composter ls command only lists categories. Users cannot view the specific components stored within those categories directly from the terminal. This creates friction because users have to switch to the Web Dashboard to find the exact component names required for the pull command.

Describe the solution you'd like
I would like to extend the ls command to support listing components.

Command Usage:

  1. composter ls <category-name>: Lists all components within the specified category.
  2. composter ls --all: Lists all categories and their respective components recursively.

Desired Output Format:
The output should be structured as follows in the terminal:

<category1>
c1 c2 c3 c4... 

<category2>
c1 c2 c3 c4...

Documentation Updates:

  • Update the Docs > CLI > List components section.
  • The documentation should reflect this new usage.
  • The example output in the docs should match the visual style of the existing category listing but include the new component details as formatted above.

Acceptance Criteria

  • Implement composter ls <category-name> to fetch and display components for a specific category.
  • Implement composter ls --all to fetch and display all categories with their components.
  • Ensure the terminal output matches the requested format (Category Name on one line, components listed below it).
  • Handle errors gracefully (e.g., if <category-name> does not exist).
  • Documentation: Update the "List components" section in the CLI docs with the new commands and updated terminal output examples.
  • PR Requirement: The Pull Request must include screenshots of the command working in the terminal.

Metadata

Metadata

Assignees

No one assigned

    Labels

    backendAPI, Database, Server taskscliCommand Line Interface specific taskspriority: mediumImportant but not urgent

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions