docs(cli): correct boolean flag syntax and pipeline defaults

Merged
YO
2mo ago
+35-14

Why

incur boolean flags do not consume the following token. --flag false sets the flag to true and leaves false as a stray positional argument, so every documented example did the opposite of what the reader asked for.

Verified against incur's parser:

WrittenParsed
--include-in-pipeline falsetrue โ† the documented form
--include-in-pipelinetrue
--include-in-pipeline=falsefalse
--no-include-in-pipelinefalse

What changed

  • Fixed the broken example. SKILLS.md told readers to exclude a contract from the pipeline with formo contracts update <chain> <address> --include-in-pipeline false, which included it instead. Added a note on both affected flags (--include-in-pipeline, --is-public).
  • Corrected the --include-in-pipeline description. It read "true by default in the API". The API default is decode-only (false), and after getformo/formono#2251 an omitted field preserves the stored value rather than resetting it.
  • Clarified --is-public on create (defaults to private) and update (omitting preserves the stored value).
  • Extended the incur patch so rendered --help examples emit --flag / --flag=false instead of --flag false, which stopped the CLI's own help from teaching the wrong syntax. This follows the existing patch precedent in this repo for incur's flag rendering.

Related

Companion to getformo/formono#2251, which makes an omitted include_in_pipeline on PUT /v0/contracts/{chain}/{address} preserve the stored value instead of silently disabling pipeline ingestion.

Testing

197 passing, 1 pending, 0 failing. Typecheck and lint clean.

Docs-only plus a dependency patch; no source behaviour changes.

๐Ÿค– Generated with Claude Code

https://claude.ai/code/session_012hZAuHtXHkZN3BPnHqyRQK


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.