feat: add Examples sections on high-traffic commands
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 72/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- typescript
- Domain
- cli, documentation, testing
Research direction
Start at the listed command definitions and the commander addHelpText usage, then inspect how generated --help output is tested. Add Examples blocks for each requested command, including the specified happy path, --json, and applicable --dry-run or --save-as cases. Done when tests confirm every listed command's --help contains its examples.
Written by the indexing model from the issue text.
Description
Generated --help is schema descriptions only. That is correct for 200+ generated endpoints and wrong for the commands people actually run first.
Hand-author Examples (commander addHelpText) on a short list, not the full tree:
elastic config context add/list/current-context setelastic statuselastic stack es search,indices create,indices delete,cat indiceselastic cloud serverless projects create(and the--save-aspath)elastic docs search
Keep examples copy-pasteable. One happy path, one --json, one --dry-run where it mutates.
Acceptance: each listed command's --help has an Examples block. Tests assert the strings are present so codegen cannot wipe them.
- Dominant language
- TypeScript
- Stars
- 43
- Forks
- 24
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 59
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 elastic/cli
-
cloud enhancement
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Similar issues
-
Browser Waiting for: Product Owner
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
getsentry/sentry-javascript#24577 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
agilepathway/label-checker#640 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
copse-dev/agent-pane#2953 ·
-
agentic-workflows
Difficulty 1/5 Under an hour Newbie friendliness 85/100
githubnext/rig#534 ·
-
automation missing-model model-sync provider:pioneer
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
anomalyco/models.dev#7701 ·