github/larksuite-cli
1
0
Fork 0
mirror of https://github.com/larksuite/cli.git synced 2026-07-03 14:02:43 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix(cli): stop root --help listing per-command flags as global (#1223)

Browse Source 
The hand-written FLAGS block in `lark-cli --help` listed --params, --data,
--as, --format, --page-all, --page-size, --page-limit, --page-delay, -o,
--jq, -q and --dry-run as if they were global flags. None are registered
on the root command — they all error "unknown flag" at the top level and
exist only on leaf commands (api, service). The block also contradicted
the Cobra-generated "Flags:" section rendered directly below it, which
shows only -h/--help, --profile, -v/--version.

Replace it with a short illustrative example list (common flags first) and
a pointer to `lark-cli <command> --help` for the full per-command set.
Root help stays a discovery signpost without claiming the flags are global
or restating defaults/descriptions that drift from the real flag sets.

Change-Id: Ia1cab889dd70b6b49a61dac468dedfd7fe39043f
This commit is contained in:
liangshuo-1
2026-06-02 20:11:20 +08:00
committed by GitHub
parent 0aa9e96d18
commit b0b163d0ef
2 changed files with 13 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
cmd/root.go
View File

@@ -49,18 +49,8 @@ EXAMPLES:
lark-cli api GET /open-apis/calendar/v4/calendars
FLAGS:
--params <json> URL/query parameters JSON
--data <json> request body JSON (POST/PATCH/PUT/DELETE)
--as <type> identity type: user | bot
--format <fmt> output format: json (default) | ndjson | table | csv | pretty
--page-all automatically paginate through all pages
--page-size <N> page size (0 = use API default)
--page-limit <N> max pages to fetch with --page-all (default: 10, 0 for unlimited)
--page-delay <MS> delay in ms between pages (default: 200, only with --page-all)
-o, --output <path> output file path for binary responses
--jq <expr> jq expression to filter JSON output
-q <expr> shorthand for --jq
--dry-run print request without executing
e.g. --as, --format, -q/--jq, --dry-run ...
Run lark-cli <command> --help for the full list.
AI AGENT SKILLS:
lark-cli pairs with AI agent skills (Claude Code, etc.) that

11
cmd/root_test.go
View File

@@ -83,6 +83,17 @@ func TestRootLong_AgentSkillsLinkTargetsReadmeSection(t *testing.T) {
}
}
func TestRootLong_FlagsSectionPointsToCommandHelp(t *testing.T) {
// The flags shown in root help live on leaf commands (api, service), not
// on the root command — every one errors "unknown flag" at the top level.
// So the FLAGS section may only list them as examples and must route to
// `<command> --help` for the full set, rather than re-list them as if they
// were global root flags (which both lies and drifts as flags change).
if !strings.Contains(rootLong, "lark-cli <command> --help") {
t.Fatalf("root help FLAGS section must point to `lark-cli <command> --help` for the flag list, got:\n%s", rootLong)
}
}
func TestConfigureFlagCompletions(t *testing.T) {
t.Cleanup(func() { cmdutil.SetFlagCompletionsEnabled(false) })