Skip to content

doc: tell users to install skills from local clone - #1425

Open
vegerot wants to merge 1 commit into
larksuite:mainfrom
vegerot:pr1425
Open

vegerot wants to merge 1 commit into
larksuite:mainfrom
vegerot:pr1425

Conversation

@vegerot

@vegerot vegerot commented Jun 12, 2026 •

Copy link
Copy Markdown
Contributor

Summary: Update README.md to instruct users to install the CLI SKILL from the local clone instead of from the GitHub repository. If users install from the GitHub repository, they may not get the latest changes that are present in the local clone.

Summary by CodeRabbit

  • Documentation
    • Updated the README Quick Start instructions to install the CLI skill from the current directory when setting up from source.

Copilot AI review requested due to automatic review settings June 12, 2026 03:41
@coderabbitai

coderabbitai Bot commented Jun 12, 2026 •

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The README "From source" Quick Start installation command now uses npx skills add ./ -y -g to install the CLI SKILL from the current directory.

Changes

Quick Start Installation Documentation

Layer / File(s) Summary
Installation command update
README.md
The CLI SKILL installation command now uses ./ instead of larksuite/cli.

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

Possibly related PRs

Suggested reviewers: liangshuo-1

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description states the motivation but omits the required Changes, Test Plan, and Related Issues sections. Add the required sections and list the README change, verification steps, and related issue status.
✅ Passed checks (4 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly and concisely describes the README change to install skills from the local clone.
✨ 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.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates the installation instructions to install the CLI skill from the local repository instead of from the larksuite/cli package reference.

Changes:

  • Replace npx skills add larksuite/cli -y -g with npx skills add ./ -y -g in the README install instructions.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
@github-actions github-actions Bot added the size/S Low-risk docs, CI, test, or chore only changes label Jun 12, 2026
@CLAassistant

CLAassistant commented Jun 12, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

Summary: Update README.md to instruct users to install the CLI SKILL from the local clone instead of from the GitHub repository. If users install from the GitHub repository, they may not get the latest changes that are present in the local clone.
Copilot AI review requested due to automatic review settings July 31, 2026 22:09

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Suppressed comments (1)

README.md:79

  • The switch to a local-path install (./) is only implied by the command. Since other user-facing docs/help still recommend npx skills add larksuite/cli -y -g (e.g. README.zh.md and the root help template), this section can be confusing. Suggest making the “from source” instructions explicitly say the skills are installed from the local clone, and consider aligning the other references in a follow-up.
npx skills add ./ -y -g

@github-actions

Copy link
Copy Markdown

PR Quality Summary

CI did not complete successfully. Use the failed check links below to decide whether this PR needs a code change or a rerun.

CI status

  • Workflow conclusion: failure.

This branch has not been deployed

No deployments
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.

3 participants