Summary
On @larksuite/cli v1.0.38, several shortcut --help pages advertise flags that do not match the actual accepted runtime flags.
This caused repeated validation failures during real usage because the documented flag shape and the executable flag shape diverged.
Environment
- Package:
@larksuite/cli
- Version:
1.0.38
- OS: macOS
Mismatches observed
1. docs +create --help shows --markdown, but runtime requires --doc-format markdown --content ...
lark-cli docs +create --help advertises:
But invoking docs +create with --markdown fails at runtime with:
In practice, the working form was:
lark-cli docs +create \
--profile runtime-bot \
--as bot \
--api-version v2 \
--wiki-node "$ROOT_NODE_TOKEN" \
--title "$REPORT_DATE" \
--doc-format markdown \
--content "$MARKDOWN_CONTENT"
2. docs +update --help shows --mode, but runtime requires --command overwrite
lark-cli docs +update --help advertises:
But invoking docs +update using the documented shape failed with:
In practice, the working form was:
lark-cli docs +update \
--profile runtime-bot \
--as bot \
--api-version v2 \
--doc "$DOC_TOKEN" \
--command overwrite \
--doc-format markdown \
--content "$MARKDOWN_CONTENT"
Also, using --command replace_all failed validation; accepted values included overwrite, append, etc.
3. wiki +node-delete uses --node-token, not --token
This one is smaller, but worth calling out because wiki +node-get uses --token, while wiki +node-delete expects:
That inconsistency makes it easy to carry the wrong mental model between adjacent wiki commands.
Expected behavior
Either:
- the
--help output should reflect the real accepted flags and values, or
- compatibility aliases should be added so the documented flags also work.
For the docs shortcuts, the current divergence between --help and runtime behavior is especially confusing for both humans and AI agents.
Why this matters
This came up in a real automation path, not a synthetic test. The main issue was not that the commands were hard to use, but that the advertised invocation shape was accepted as authoritative and then failed with validation errors.
Summary
On
@larksuite/cliv1.0.38, several shortcut--helppages advertise flags that do not match the actual accepted runtime flags.This caused repeated validation failures during real usage because the documented flag shape and the executable flag shape diverged.
Environment
@larksuite/cli1.0.38Mismatches observed
1.
docs +create --helpshows--markdown, but runtime requires--doc-format markdown --content ...lark-cli docs +create --helpadvertises:--markdown stringBut invoking
docs +createwith--markdownfails at runtime with:--content is requiredIn practice, the working form was:
2.
docs +update --helpshows--mode, but runtime requires--command overwritelark-cli docs +update --helpadvertises:--mode stringBut invoking
docs +updateusing the documented shape failed with:--command is requiredIn practice, the working form was:
Also, using
--command replace_allfailed validation; accepted values includedoverwrite,append, etc.3.
wiki +node-deleteuses--node-token, not--tokenThis one is smaller, but worth calling out because
wiki +node-getuses--token, whilewiki +node-deleteexpects:--node-tokenThat inconsistency makes it easy to carry the wrong mental model between adjacent wiki commands.
Expected behavior
Either:
--helpoutput should reflect the real accepted flags and values, orFor the
docsshortcuts, the current divergence between--helpand runtime behavior is especially confusing for both humans and AI agents.Why this matters
This came up in a real automation path, not a synthetic test. The main issue was not that the commands were hard to use, but that the advertised invocation shape was accepted as authoritative and then failed with validation errors.