docs: point agents at cli-schema from help and README

Open Beginner friendly
#632 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
typescript
Domain
cli, documentation

Research direction

Update the root --help LEARN MORE text, the README install path, and add CLAUDE.md containing only @AGENTS.md. Verify that elastic --help mentions cli-schema and --help --json, the README has the short “for agents” block, and CLAUDE.md references AGENTS.md only.

Written by the indexing model from the issue text.

Description

enhancement

elastic cli-schema and docs/cli/schema.json are easy to miss: not on root --help, not in the README install path, and cli-schema is a reserved meta command.

Add one line to root --help (LEARN MORE) and a short README section: prefer elastic <cmd> --help --json for one command, elastic cli-schema for the full tree. Do not tell agents to ingest the 100k-line schema.json.

Also add a one-line CLAUDE.md that is @AGENTS.md.

Acceptance: elastic --help mentions cli-schema and --help --json. README has a short "for agents" block. CLAUDE.md exists and only references AGENTS.md.

Dominant language
TypeScript
Stars
43
Forks
24
Avg merge
1d 7h
Merged PRs (30d)
55

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from elastic/cli

All issues in elastic/cli

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.