Skip to content
YoloSearchDocs

Reference

Reference

Command, configuration, and metrics references, plus definitions of the terms used in the documentation.

These pages are lookup tables. They exist so you can check a flag name, a default, a metric label, or a term without reading prose around it.

The pages

Page Contents
CLI Every yolosearch command, its arguments, and its command-specific flags
Configuration Every setting, with kind, scope, default, environment variable, and flag
Metrics Every exported Prometheus family, with type, labels, and meaning
Glossary The vocabulary the rest of the documentation assumes

Where these facts come from

The command and configuration references are derived from docs/cli.md in the YoloSearch repository, which is generated by yolosearch manual and from the binary's own configuration catalog. A manual-check stage in continuous integration fails on drift, so the generated file cannot fall behind the binary.

The metric names, types, and labels come from internal/metrics. The engine validates its registries and label cardinality. The console exports separate gauges from internal/adminbridge/metrics.go. This site's manual tables can lag the implementation; inspect /metrics for the process you are running.

Asking the binary directly

Question Command
What commands exist? yolosearch --help
What does one command take? yolosearch <command> --help
The complete manual as Markdown yolosearch manual
What is every setting, and where did its value come from? yolosearch config list
What is one setting set to right now? yolosearch config get <key>
What will this process resolve to before it starts? yolosearch config export --yaml
What is this process exporting? curl localhost:9550/metrics

config get and config list report each value and its source layer. Use that provenance to identify which file, environment variable, flag, or runtime override set it.