ewcloud / ewcloud/ewccli

[FEATURE] Displayed Item metadata shows run command and input hints at the top

Open
#79 0 comments 0 reactions 1 assignee Claimed by @pacospace View on GitHub
enhancement
Dominant language
Python
Stars
3
Forks
4
Avg merge
1d 17h
Merged PRs (30d)
11

Description

### Summary

The metadata show by `ewc hub show ` includes hints about how to run and what inputs are available. However, this info is towards the end, easy to miss if one get caught in the description. This info should be easy to find, at the top, maybe right after the Item name and version. Not at the bottom.

### Motivation

The EWCCLI does a good job at parsing the Item metadata and showing what is the minimal set of inputs, and their values, that one can use to deploy an Item.
This is useful both for users that are familiar with the Item and just want to quickly check what command they need to pass, or for new users that do not have a clue what the Item needs and did not care to look at the Item docs, this info should be easier to find, at the top of the results of `ewc hub show `.

### Proposed Implementation

No changes to the EWCCLI api, just reordering of the information displayed when running:
```bash
ewc hub show
```

### Alternatives Considered

Putting command hints in the docs of the Items is possible, but then there is a higher risk of documentation there and the auto-generated hints of the EWCCLI to getting out of sync or stale.

### Priority

None

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.