elastic / elastic/cli

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

Open
#632 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
41
Forks
24
Avg merge
1d 3h
Merged PRs (30d)
56

Description

`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 --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`.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.