docs(cli): correct boolean flag syntax and pipeline defaults by yosriady · Pull Request #48 · getformo/cli

yosriady · 2026-08-25T04:20:55Z

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:

Written	Parsed
`--include-in-pipeline false`	`true` ← the documented form
`--include-in-pipeline`	`true`
`--include-in-pipeline=false`	`false`
`--no-include-in-pipeline`	`false`

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.

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

^{Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.}

incur boolean flags do not consume the following token: `--flag false` sets the flag to **true** and leaves `false` as a stray positional. Every documented example used that form, so following the docs did the opposite of what the reader asked for. The forms the parser honours are `--flag`, `--flag=false`, and `--no-flag` (all verified against incur's parser). - Fix the `contracts update --include-in-pipeline false` example in SKILLS.md and add a note on both affected flags. - Correct the `--include-in-pipeline` description. It read "`true` by default in the API"; the API default is decode-only (false), and after the backend fix an omitted field preserves the stored value. - Clarify `--is-public` on create (defaults to private) and update (omitting preserves). - Extend the incur patch so rendered `--help` examples emit `--flag` and `--flag=false` instead of the broken `--flag false`, which stops the CLI's own help from teaching the wrong syntax. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012hZAuHtXHkZN3BPnHqyRQK

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 68c26d73df

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector · 2026-08-25T04:23:33Z

+            for (const [key, value] of Object.entries(ex.options)) {
+                const flag = `--${key.replace(/[A-Z]/g, (c) => `-${c.toLowerCase()}`)}`;


Refresh the lockfile after changing the dependency patch

These edits change the patch digest from ae188796… to 01acbccc…, but pnpm-lock.yaml still records the old digest in both patchedDependencies and the incur resolution. Consequently, every build, test, and release job that runs pnpm install --frozen-lockfile (for example, .github/workflows/ci.yml:33-34) will reject the stale lockfile before running any checks. Regenerate and commit the lockfile alongside this patch.

Useful? React with 👍 / 👎.

cubic-dev-ai

All reported issues were addressed across 3 files

_{Reply with feedback, questions, or to request a fix.

Re-trigger cubic}

- Editing patches/incur@0.4.26.patch changes its sha256, which pnpm records in pnpm-lock.yaml (patchedDependencies plus the incur resolution). The lockfile still held the old digest, so every CI job running `pnpm install --frozen-lockfile` rejected it before any check ran. Updated all three references; a frozen install now succeeds and applies the patch. - The pipeline-toggle example omitted `--name`, `--abi`, and `--events`. `contracts update` is a full replace and requires them, so copying the snippet failed with a missing-option error. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012hZAuHtXHkZN3BPnHqyRQK

yosriady · 2026-08-25T05:33:50Z

Both review points are addressed in 6c8ae62. CI is green.

P1, lockfile digest. Correct — editing the patch changes its sha256, and pnpm-lock.yaml still held ae188796… in patchedDependencies, the importer entry, and the incur resolution, so every pnpm install --frozen-lockfile job rejected it before running. Updated all three to 01acbccc…. Verified locally: pnpm install --frozen-lockfile now succeeds and applies the patch (pnpm re-hashes the file, so a wrong digest would fail).
P2, incomplete example. Correct — contracts update is a full replace and requires --name, --abi, and --events. The snippet now includes them, with a line saying why.

197 passing, 1 pending, 0 failing; lint and typecheck clean.

yosriady mentioned this pull request Aug 25, 2026

docs: sync the API spec and fix CLI boolean and MCP transport docs getformo/docs.formo.so#142

Merged

chatgpt-codex-connector Bot reviewed Aug 25, 2026

View reviewed changes

cubic-dev-ai Bot reviewed Aug 25, 2026

View reviewed changes

Comment thread SKILLS.md Outdated

yosriady merged commit 0f192fe into main Aug 25, 2026
9 checks passed

yosriady deleted the fix/cli-boolean-flag-docs branch August 25, 2026 05:54

Navigation Menu

Uh oh!

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

docs(cli): correct boolean flag syntax and pipeline defaults#48
yosriady merged 2 commits into
mainfrom
fix/cli-boolean-flag-docs

yosriady commented Aug 25, 2026 •

edited by cubic-dev-ai Bot

Loading

Uh oh!

chatgpt-codex-connector Bot left a comment

Uh oh!

chatgpt-codex-connector Bot Aug 25, 2026

Uh oh!

cubic-dev-ai Bot left a comment •

edited

Loading

Uh oh!

Uh oh!

yosriady commented Aug 25, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

		+ for (const [key, value] of Object.entries(ex.options)) {
		+ const flag = `--${key.replace(/[A-Z]/g, (c) => `-${c.toLowerCase()}`)}`;

Uh oh!

Conversation

yosriady commented Aug 25, 2026 • edited by cubic-dev-ai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why

What changed

Related

Testing

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

chatgpt-codex-connector Bot Aug 25, 2026

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai Bot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

yosriady commented Aug 25, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

yosriady commented Aug 25, 2026 •

edited by cubic-dev-ai Bot

Loading

cubic-dev-ai Bot left a comment •

edited

Loading