Skip to content

docs: add agent cli guide#1649

Merged
yifancong merged 8 commits intomainfrom
docs/agent-cli
May 8, 2026
Merged

docs: add agent cli guide#1649
yifancong merged 8 commits intomainfrom
docs/agent-cli

Conversation

@yifancong
Copy link
Copy Markdown
Contributor

@yifancong yifancong commented May 7, 2026

Summary

This pull request adds detailed documentation for the new @rsdoctor/agent-cli command-line tool to both the English and Chinese AI integration guides. The documentation explains the purpose of the CLI, its main commands, usage scenarios, and provides example commands and screenshots to help users and AI agents leverage Rsdoctor’s analysis capabilities more effectively.

Documentation updates for Agent CLI:

  • Added a new section describing @rsdoctor/agent-cli, including its purpose, installation instructions, and main commands, to both the English (ai.mdx) and Chinese (ai.mdx) guides.

Related Links

Copilot AI review requested due to automatic review settings May 7, 2026 07:51
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: f3689c0703

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread packages/document/docs/en/guide/start/ai.mdx
Comment thread packages/document/docs/en/guide/start/ai.mdx Outdated
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds documentation for the new @rsdoctor/agent-cli workflow so Agents can query Rsdoctor analysis data from the command line.

Changes:

  • Add an “Agent CLI” section to the AI getting-started page (EN/ZH).
  • Document basic rsdoctor-agent commands and provide example usage with screenshots.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 12 comments.

File Description
packages/document/docs/en/guide/start/ai.mdx Adds an Agent CLI guide section, command list, and examples to the English AI docs.
packages/document/docs/zh/guide/start/ai.mdx Adds the same Agent CLI guide section, command list, and examples to the Chinese AI docs.

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

Comment thread packages/document/docs/en/guide/start/ai.mdx Outdated
Comment thread packages/document/docs/en/guide/start/ai.mdx Outdated
Comment thread packages/document/docs/en/guide/start/ai.mdx
Comment thread packages/document/docs/en/guide/start/ai.mdx
Comment thread packages/document/docs/en/guide/start/ai.mdx
Comment thread packages/document/docs/zh/guide/start/ai.mdx Outdated
Comment thread packages/document/docs/zh/guide/start/ai.mdx
Comment thread packages/document/docs/zh/guide/start/ai.mdx
Comment thread packages/document/docs/zh/guide/start/ai.mdx
Comment thread packages/document/docs/zh/guide/start/ai.mdx Outdated
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 7, 2026

Deploying rsdoctor with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6fc182a
Status: ✅  Deploy successful!
Preview URL: https://448d92e7.rsdoctor.pages.dev
Branch Preview URL: https://docs-agent-cli.rsdoctor.pages.dev

View logs

yifancong and others added 5 commits May 7, 2026 16:09
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@yifancong yifancong requested a review from fi3ework May 7, 2026 08:39
Comment thread packages/document/docs/zh/guide/start/ai.mdx Outdated
Comment thread packages/document/docs/zh/guide/start/ai.mdx
Comment thread packages/document/docs/zh/guide/start/ai.mdx Outdated
Comment thread packages/document/docs/zh/guide/start/ai.mdx
Comment thread packages/document/docs/zh/guide/start/ai.mdx Outdated
Comment thread packages/document/docs/zh/guide/start/ai.mdx
@yifancong yifancong requested a review from fi3ework May 8, 2026 09:08
@yifancong yifancong merged commit 96f4827 into main May 8, 2026
5 checks passed
@yifancong yifancong deleted the docs/agent-cli branch May 8, 2026 10:47
@yifancong yifancong mentioned this pull request May 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants