Implement help as a plugin to show detailed command help
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- javascript, node.js
- Domain
- cli
Research direction
Start by reviewing the relationship to issue #101 and the current shx command and plugin entry points. Determine how command-specific help can be exposed without parsing ShellJS documentation, then define completion as shx help <command> producing detailed usage output for supported commands.
Written by the indexing model from the issue text.
Description
Branching off from #101. It would be cool to implement shx help as a ShellJS plugin, and let this show help output at a finer granularity:
$ shx help ls
Usage: ls [option]... [file]...
-l use a long listing format
...
$ shx help cp
...
Not sure if there's a good way to do this right now without parsing ShellJS docs. But we could certainly support
- Dominant language
- JavaScript
- Stars
- 1.9k
- Forks
- 52
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 1
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from shelljs/shx
-
fix Windows
Difficulty 3/5 1-2 days Newbie friendliness 48/100
-
Windows
Difficulty 3/5 1-2 days Newbie friendliness 48/100
-
dependencies
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
low priority sed
Difficulty 3/5 1-2 days Newbie friendliness 35/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
docToolchain/docToolchain#1705 ·
-
Timezone select lists one option per character; duplicate "Failed" reason; shared tracker popover id Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
nightscout/nocturne#1414 ·
-
bug v2
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
modelcontextprotocol/inspector#2458 · 1 comment ·
-
Mend: dependency security vulnerability status: needs triage 🕵️♀️
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
carbon-design-system/ibm-products#9907 ·