Files

teernisse 4f483c82e5 Add README and agent documentation

README covers installation, quick start, all commands and flags,
filtering behavior, JSON output schemas, structured error format,
exit codes, CLI input tolerance examples, and shell completion.

AGENTS.md provides a concise reference for AI agents interacting
with pubcli: accepted flexible input forms, canonical syntax
examples, and error behavior notes.

2026-02-22 21:42:15 -05:00

642 B

Raw Blame History

Agent CLI Notes

The pubcli CLI is intentionally tolerant of minor syntax mistakes when intent is clear.

Accepted flexible forms include:

-zip 33101 -> interpreted as --zip 33101
zip=33101 -> interpreted as --zip=33101
--ziip 33101 -> interpreted as --zip 33101
categoriess -> interpreted as categories

The CLI prints a note: line when it auto-corrects input. Use canonical syntax in future commands:

pubcli --zip 33101
pubcli --store 1425 --bogo
pubcli categories --zip 33101
pubcli stores --zip 33101 --json

When intent is unclear, errors include a direct explanation and relevant examples.

642 B Raw Blame History

Agent CLI Notes

642 B

Raw Blame History