Reference
Reference
Command, configuration, gRPC, and metrics references, plus the vocabulary the rest of the documentation assumes.
These pages are lookup tables. They exist so you can check a flag name, a default, an RPC, a metric label, or a term without reading prose around it.
| Page | Contents | Source |
|---|---|---|
| CLI | Every ysearch command and flag |
generated from docs/cli.md |
| Configuration | Every setting, with default, scope, environment variable, and flag | generated from ysearch.example.yml |
| gRPC services | Every service and RPC | generated from api/ysearch/v1/*.proto |
| Metrics | Every exported Prometheus family, with type, labels, and meaning | written against internal/metrics |
| Glossary | The terms of the design and of the inherited engine | written |
The CLI, configuration, and gRPC pages, and the status page, are
generated from files of the ysearch repository at one pinned revision,
named at the top of each page. In the ysearch repository, docs/cli.md is
written by ysearch manual and ysearch.example.yml by the configuration
catalog, and its CI fails when either drifts from the binary. This site
vendors those files with a lock of their sha256 digests, and its own gate
fails when a generated page differs from what the pinned files produce.
All of them describe main today: the inherited engine plus the ysearch work
landed so far. The ysearch API of the design (RESP commands and the
document, traffic, campaign, dial, match, and app services) is not in them
yet. See Status.