adobe / adobe/aio-cli-plugin-runtime

Aliases do not produce the same help docs

Open
#271 1 comment 0 reactions 0 assignees View on GitHub
bug
Dominant language
JavaScript
Stars
21
Forks
33
PR merge metrics
No merged PRs in 30d

Description

I am not sure if it is recent Oclif changes, or our own extensive command/topic aliasing but using `rt` in place of `runtime` produces much less context in --help

```
aio runtime action --help
Manage your actions

USAGE
$ aio runtime action [--cert] [--key] [--apiversion] [--apihost] [-u] [-i] [--debug ] [-v] [--version] [--help]

FLAGS
-i, --insecure bypass certificate check
-u, --auth whisk auth
-v, --verbose Verbose output
--apihost whisk API host
--apiversion whisk API version
--cert client cert
--debug= Debug level output
--help Show help
--key client key
--version Show version

DESCRIPTION
Manage your actions

ALIASES
$ aio rt action

COMMANDS
runtime action create Creates an Action
runtime action delete Deletes an Action
runtime action get Retrieves an Action
runtime action invoke Invokes an Action
runtime action list Lists all the Actions
runtime action update Updates an Action
```

Versus the same thing with the rt alias

```
aio rt action --help
Manage your actions

USAGE
$ aio rt action [--cert] [--key] [--apiversion] [--apihost] [-u] [-i] [--debug ] [-v] [--version] [--help]

FLAGS
-i, --insecure bypass certificate check
-u, --auth whisk auth
-v, --verbose Verbose output
--apihost whisk API host
--apiversion whisk API version
--cert client cert
--debug= Debug level output
--help Show help
--key client key
--version Show version

DESCRIPTION
Manage your actions

ALIASES
$ aio rt action

```

Contributor guide

Open the contributing guide

Research direction

Reproduce the difference between `aio runtime action --help` and `aio rt action --help`, then inspect the Oclif command/topic aliasing entry points used by the runtime and `rt` commands. Done means the aliased help includes the same command context and documentation as the canonical command.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
cli
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.