Skip to content

docs: guide agents to reuse installed CLI#1832

Open
xu91102 wants to merge 1 commit into
larksuite:mainfrom
xu91102:docs/agent-existing-cli-detection
Open

docs: guide agents to reuse installed CLI#1832
xu91102 wants to merge 1 commit into
larksuite:mainfrom
xu91102:docs/agent-existing-cli-detection

Conversation

@xu91102

@xu91102 xu91102 commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

背景

Fixes #1543.

AI agents can repeatedly ask users to install lark-cli because the quick-start flow starts with installation and does not tell agents to detect an existing CLI first.

核心改动

  • Update the English AI Agent quick start to check command -v lark-cli && lark-cli --version before installing.
  • Add the same guidance to the Chinese README.
  • Clarify that normal lark-cli usage does not require an MCP server; the CLI is a regular terminal command and Skills provide usage routing.

验证

  • git diff --check: passed
  • conflict marker scan: passed, no matches
  • go test ./internal/qualitygate/rules -count=1: passed

风险与回滚

Docs-only change. Revert this commit to restore the previous quick-start wording.

Summary by CodeRabbit

  • Documentation
    • Updated the AI Agent quick start steps to check whether lark-cli is already available before installing it.
    • Clarified that normal CLI use does not require additional MCP setup.
    • Added guidance on when and how bundled Skills can be used during installation.

@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0bc4b156-dc22-460e-8e45-cda2516414f7

📥 Commits

Reviewing files that changed from the base of the PR and between 74d8458 and 4b1326a.

📒 Files selected for processing (2)
  • README.md
  • README.zh.md

📝 Walkthrough

Walkthrough

README.md and README.zh.md were updated to change the AI Agent Quick Start "Step 1" instructions from an unconditional install command to a conditional check that first detects whether lark-cli is already installed and runnable, only installing via npx if not found, plus clarifying text about MCP server not being required.

Changes

Quick Start Documentation Update

Layer / File(s) Summary
Detect-or-install Step 1 instructions
README.md, README.zh.md
Replaces unconditional npx @larksuite/cli@latest install instruction with conditional logic checking command -v lark-cli and lark-cli --version first, installing only if unavailable, and adds clarifying text that MCP server configuration is not required for normal CLI usage.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

  • larksuite/cli#464: Implements the same conditional "check for existing/runnable lark-cli before installing" logic in scripts/install-wizard.js, mirroring the behavior this PR documents in the README.

Suggested labels: documentation, size/S

Suggested reviewers: liangshuo-1, caojie0621

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately summarizes the docs change to reuse an installed CLI first.
Description check ✅ Passed The description covers the motivation, main changes, verification, and linked issue, though it uses different headings than the template.
Linked Issues check ✅ Passed The changes address #1543 by checking for an existing lark-cli first and clarifying that MCP is not required for normal use.
Out of Scope Changes check ✅ Passed The PR stays within the documented CLI quick-start guidance and adds no unrelated code or scope.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added the size/S Low-risk docs, CI, test, or chore only changes label Jul 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/S Low-risk docs, CI, test, or chore only changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

codex每次都会遗忘本机已安装飞书cli,每次需要引导它,如何处理?

1 participant