-
Notifications
You must be signed in to change notification settings - Fork 15
Open
Labels
backendAPI, Database, Server tasksAPI, Database, Server taskscliCommand Line Interface specific tasksCommand Line Interface specific taskspriority: mediumImportant but not urgentImportant but not urgent
Description
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:
composter ls <category-name>: Lists all components within the specified category.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 --allto 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.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
backendAPI, Database, Server tasksAPI, Database, Server taskscliCommand Line Interface specific tasksCommand Line Interface specific taskspriority: mediumImportant but not urgentImportant but not urgent