feat: surface preview and deprecated APIs in help
Maintainers usually reply within 1 day
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 68/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- typescript
- Domain
- cli
Research direction
Start by reading ARCHITECTURE.md and locating the CLI entry points for --help, --help --json, and --command-profile. Trace how x-deprecated and x-availability are retained on schemas and how command invocation is dispatched. Done means deprecated commands are marked in both help formats, invocation emits a one-line stderr warning while still running, and help itself emits no warning.
Written by the indexing model from the issue text.
Description
We keep x-deprecated / x-availability on schemas and do not show them (ARCHITECTURE.md). The whole CLI is tech preview, but some generated endpoints are already deprecated upstream.
- Mark deprecated flags/commands in
--help(and--help --json) - Emit a one-line stderr warning when a deprecated command runs (not when
--helpruns) - Optional: prefix preview-only namespaces when
--command-profilehides the rest
Do not hide deprecated commands before 1.0; warn only.
Acceptance: a deprecated command's --help says deprecated. Invoking it prints a warning on stderr and still runs.
- Dominant language
- TypeScript
- Stars
- 47
- Forks
- 27
- Avg merge
- 2d 6h
- Merged PRs (30d)
- 52
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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
-
feat: ship skills/elastic/SKILL.md for agent invocationPossibly taken @onatozmenn claimed this 14 days ago. Openenhancement
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 3/5 Half a day Newbie friendliness 62/100
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 20/100
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 70/100
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
cline/mcp-marketplace#2932 ·
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 82/100
lingdojo/kana-dojo#32188 · 1 comment · 5 reactions ·
Maintainers usually reply within 1 day
-
triage
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Portkey-AI/gateway#1844 ·
Maintainers usually reply within 1 day
-
needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 61/100
rjsf-team/react-jsonschema-form#5495 ·
Maintainers usually reply within 2 days