larksuite / larksuite/cli

Clarify whether lark-cli commands consume Feishu OpenAPI quota

Open
#1,167 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

domain/core question
Dominant language
Go
Stars
17.3k
Forks
1.4k
Avg merge
2d 4h
Merged PRs (30d)
105

Description

Question

When users run lark-cli, it is not immediately clear which commands consume Feishu/Lark OpenAPI quota and where a personal user or app developer can inspect the remaining usage. This is especially important for AI-agent workflows, where a single user action may trigger multiple CLI commands.

Could the project clarify the quota behavior in README/docs/help?

Specific points to clarify

  1. Do executed shortcut commands, generated API commands, and raw lark-cli api calls count against the tenant/app OpenAPI monthly call quota in the same way as SDK/curl requests?
  2. Are local-only commands such as --help, schema, config, profile, and --dry-run excluded from quota because they do not execute OpenAPI requests?
  3. For paginated commands such as --page-all, should users expect quota usage to equal the actual number of OpenAPI requests/pages fetched?
  4. Where can an individual user or app developer view quota usage? Current understanding is that enterprise admins can view it in Feishu Admin Console -> Billing/费用中心 -> Entitlements/权益数据, but ordinary personal users may not have access.
  5. Should quota/rate-limit errors such as 99991403 or 99991400 get a dedicated README/FAQ entry or CLI hint?

Why this matters

lark-cli is often used by AI agents. Users may not realize that agent-driven read/write workflows can consume OpenAPI call quota, especially when commands auto-paginate or when shortcuts perform multiple API calls internally. A short official explanation would help users choose --dry-run, pagination limits, and retry behavior more safely.

Current understanding

  • --dry-run prints the planned request without executing it, so it should not consume quota.
  • Real OpenAPI requests issued by lark-cli likely count the same as requests made through the SDK or direct HTTP calls.
  • Quota visibility appears to be tenant/admin-oriented rather than personal-user-oriented.

Please correct the above if any part is inaccurate.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing README, documentation, and help output for lark-cli api, --dry-run, --page-all, and the local-only commands named in the issue. Verify the quota behavior and visibility guidance against the command behavior and Feishu documentation, then document which requests count, where usage can be checked, and how quota or rate-limit errors are handled.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, openapi
Domain
api, cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.