Skip to content

Document the V1 commands, flags and exit rules - #18

Merged
VirtualMachinist merged 3 commits into
mainfrom
v1/readme-v1
Nov 14, 2026
Merged

VirtualMachinist merged 3 commits into
mainfrom
v1/readme-v1

Conversation

@VirtualMachinist

Copy link
Copy Markdown
Member

V1 checkpoint G4b: consumer docs.

  • README.md and docs/cli.md:
    • cover prom targets, prom query, grafana health and sources;
    • list the global flags and --host, and the table columns;
    • include the V1 exit table: an unhealthy health check exits 4 with nothing on stdout, host-argument mistakes exit 3, and an empty query result exits 0;
    • use help text taken from the real binary.
  • Examples:
    • the overlay gains a hosts[] instance-to-slug map, and the config gains a backend vantage;
    • placeholders are documentation addresses and reserved names only;
    • both files validate against their schemas and pass the scrub.

🤖 Generated with Claude Code

Signed-off-by: VirtualMachinist <252028890+VirtualMachinist@users.noreply.github.com>
Signed-off-by: VirtualMachinist <252028890+VirtualMachinist@users.noreply.github.com>
Signed-off-by: VirtualMachinist <252028890+VirtualMachinist@users.noreply.github.com>
@VirtualMachinist
VirtualMachinist merged commit ef81d94 into main Nov 14, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant