Open gregorybrzeski opened 5 years ago
ad-m
commented
5 years ago I like the idea of having a two-way connection between the CLI and the guide that uses this CLI command. First of all, it requires update structure of links to guides on the page to match CLI command name.
ad-m
commented
3 years ago We have link to API documentation for now:
$ h3 iam project list --help
h1 iam project list
List iam/project
Synopsis
$ h1 iam project list <options>
Description
See also:
* [API reference](https://api.hyperone.com/v2/docs#operation/iam_project_list)
Common options
--help Show help message and exit.
--verbose Make the operation more talkative.
-o, --output tsv,list,json,js,id,uri,yaml Specify output format of command. Default value is yaml
--query string JMESPath query string. Default value is [].{id:id, name:name,
state:state, flavour:flavour}
--passport-file path Passport file. Default value is ```~/.h1/passport.json```, if
available.
--as uri Act as another actor eg. service account
--no-wait In case of queued event do not wait for completion
-v, --version Show version and exit.
-v, --version Show version and exit.
Operation options
--name string Filter by name
--$limit string Filter by $limit
--active string Filter by active
--organisation string Filter by organisation
--$lean string return a lightweight version of the resource
--tag.value string Filter by tag.value
--tag.key string Filter by tag.key
--skeleton Display intermediary representation of operation
Maybe cli should have a way to display additional help or even links (url) to online (web) version of documentation.
Similar approach is already implemented in PowerShell however with varied degree of adoption for different sets of commands.
Interesting information on screenshot in sections:
Maybe we should include links to reference documentation for resource as well to promote adoption of it ?