乐于分享
好东西不私藏

给你的 终端/AI集成 Apire 文档

给你的 终端/AI集成 Apire 文档

你正埋头写 Aspire AppHost,代码敲到第三个文件,突然卡壳:Redis 集成到底需要哪些参数?

这时候你有两个选择:

😫 切浏览器 → 搜 aspire.dev → 眯眼找 API 文档 → 再切回来😎 直接敲一行命令,或者——更爽的是——让 AI 助手 帮你查,连脑子都不用动

Aspire 13.2 正式推出 aspire docs 命令!这是一套 CLI(Command Line Interface,命令行界面) 工具,让你不用离开终端,就能浏览、搜索、阅读官方 Aspire 文档。

更关键的是:这套 CLI 只是 Aspire 文档服务的「薄薄一层」,同一份权威数据源,人类、AI 技能、自动化脚本都能用。不是碎片快照,不是粗糙爬虫,而是 aspire.dev 的实时官方文档,用人和工具都友好的方式暴露出来✨


🤖 AI 友好 × 人类友好,双赢!

说点大实话:现在的 AI 工具,少瞎猜、多查文档,效果才能起飞🛫

不管是通过 Repo Skill、本地 Agent 工作流、自定义自动化步骤,还是你自己手动敲 CLI——形式不同,目标一致:让模型读文档,而不是靠猜

以前 AI 助手帮开发者写 Aspire 应用,那叫一个「自信地翻车」:

推荐 dotnet run 而不是 aspire run ❌把 aspire.dev 的文档链接指到 learn.microsoft.com ❌推荐过时的 NuGet 包 ❌最绝的是:凭空捏造不存在的 API ❌

为啥?因为 Aspire 早期专注 .NET 生态,而大语言模型 LLM(Large Language Model) 的训练数据往往滞后于最新特性。结果就是:AI 一脸自信地胡说八道——比明显错误更坑,至少明显错误你还会警惕对吧?

文档工具链就是来治这个的✅

当你的助手能调用 list_docssearch_docsget_doc(不管通过 Skill、本地工具集成,还是简单 CLI 封装),它就不再瞎猜,而是直接引用 aspire.dev 的实时官方文档

重点不在于「怎么传数据」,而在于:所有工作流都能访问同一份最新文档,不再依赖过时的训练数据。相当于给你栈里的每个 AI 发了一本「小抄」——但这不算作弊,这叫… 好好读文档

但架构设计有个「意外之喜」:因为我们构建的是可复用服务IDocsIndexServiceIDocsSearchServiceIDocsFetcherIDocsCache),而不是一次性集成,所以同一套搜索引擎既能通过 CLI 暴露给人类,也能让 Skills 和自动化脚本轻松复用。

而这,正是本文要聊的重点👇

💡 如果你的编辑器或 Agent 平台支持 Repo Skill 或本地工具集成,把 aspire docs listaspire docs searchaspire docs get 封装成小 Skill,你的助手就能随时拉取官方 Aspire 指南。核心思路超简单:让 AI 工具链指向 CLI,而不是赌模型背下了最新文档。


💻 aspire docs CLI:人类也配拥有丝滑体验!

aspire docs 命令让你——真实的人类开发者——直接访问和 AI 助手同一份文档索引。不用浏览器、不用切上下文,文档就在终端里。

同一套搜索引擎,同一份数据源,只是消费者不同👥

📋 列出所有文档页

aspire docs list

默认返回 aspire.dev 上所有可用文档页,人类友好格式:

 Found 264 documentation pages.┌──────────────────────────────────┬──────────────────────────────────┬──────────────────────────────────┐│ Title                            │ Slug                             │ Summary                          │├──────────────────────────────────┼──────────────────────────────────┼──────────────────────────────────┤│ Certificate configuration        │ certificate-configuration        │ Learn how to configure HTTPS     ││                                  │                                  │ endpoints and certificate trust  ││                                  │                                  │ for resources in Aspire.         ││ AppHost configuration            │ apphost-configuration            │ Learn about the Aspire AppHost   ││                                  │                                  │ configuration options.           ││ Docker Compose to Aspire AppHost │ docker-compose-to-aspire-apphost │ Quick reference for converting   ││                                  │                                  │ Docker Compose YAML to Aspire.   │└──────────────────────────────────┴──────────────────────────────────┴──────────────────────────────────┘  ... remaining 261 pages omitted for brevity.

需要结构化输出用于脚本?(或者喂给其他工具?)

aspire docs list --format Json

返回包含每页 slugtitlesummary 的 JSON 数组。适合构建本地文档索引器,或用 jq 过滤结果。

🔍 搜索主题

同时搜索页面标题和内容,结果按相关性加权评分排序(和 Aspire 文档工具链同一套算法):

aspire docs search "redis"
 Found 5 results for 'redis'.┌───────────────────────────────────┬───────────────────────────────────┬─────────────────────────────────────────────┬────────┐│ Title                             │ Slug                              │ Section                                     │ Score  │├───────────────────────────────────┼───────────────────────────────────┼─────────────────────────────────────────────┼────────┤│ Redis integration                 │ redis-integration                 │ Hosting integration                         │ 351.75 ││ Azure Cache for Redis integration │ azure-cache-for-redis-integration │ Hosting integration                         │ 319.25 ││ Redis Distributed Caching         │ redis-distributed-caching         │ Hosting integration                         │ 186.25 ││ Redis Output Caching              │ redis-output-caching              │ Hosting integration                         │ 186.25 ││ Examples                          │ examples                          │ Example: Derived Container Resource (Redis) │ 128.75 │└───────────────────────────────────┴───────────────────────────────────┴─────────────────────────────────────────────┴────────┘

用 --limit 控制结果数量:

aspire docs search "integration" --limit 5

当然,--format Json 也能给你带相关性评分的结构化输出,脚本或下游工具处理超方便✅

📖 阅读完整页面

aspire docs get redis-integration

将完整页面内容以 Markdown 格式 流式输出到终端,开箱即读。不用浏览器、不用渲染开销,纯文本搞定。

📑 阅读指定章节

文档页不一定都短,有时你只需要某一节:

aspire docs get redis-integration --section "Add Redis resource"

只返回该章节内容。当你只想快速查个 API 示例,不用滚动 500 行文档时,简直救命🆘 精准打击,手术刀级体验🔪


🔧 真实场景:你什么时候真的会用?

场景 1:Skill 辅助开发 Aspire

你在 VS Code 里写 Aspire 应用,配置了 Repo Skill 或本地工具集成。问 AI 助手:「给我的 AppHost 加个 PostgreSQL 数据库」。

助手不会瞎编 API,而是: 

1. 运行 aspire docs search "postgres"2. 找到官方集成文档3. 读取对应页面4. 给你文档认证的方案

不用切屏、不用怀疑、不用问「等等这 API 真的存在吗?」。AI 助手透明、实时帮你查文档,全程无感。

这才是核心价值:你甚至不用想「去哪查」,助手自己就知道。

场景 2:终端快速查文档(人类专属福利)

你写 AppHost 写到第三个文件,突然忘了 Redis 集成要哪些参数。

你可以:

😫 切浏览器 → 搜 aspire.dev → 眯眼找 → 再切回来😎 直接敲:

aspire docs search "redis" --limit 1aspire docs get redis-integration --section "Configuration"

90 秒搞定,全程没离开终端。上下文保住,心流不断。主厨之吻🤌

场景 3:给自定义 Skill / AI 流水线喂文档

你在 Aspire 基础上构建自己的 AI 工具?比如 Repo SkillAgent Framework 智能体,或自定义工作流?

直接管道结构化输出:

aspire docs get redis-integration --format Json | jq '.content' | xclip

完整 Redis 文档进剪贴板,随时粘贴到 AI 聊天或提示词上下文。

或者构建自定义工具,把 Aspire 文档索引到你自己的知识库:

aspire docs search "monitoring" --format Json | jq '[.[] | {slug, title, summary}]'

结构化、机器可读的文档元数据,秒级生成。不用爬虫、不用 API Key、不用折腾。

JSON 输出和文档工具链内部用的是同一份结构化数据——同一源,不同管道🔁

场景 4:CI/CD 文档校验

你的 CI 流水线会校验 Aspire AppHost。可以加一步:用官方文档验证集成配置:

#!/bin/bashREDIS_DOCS=$(aspire docs get redis-integration --format Json)# 从文档提取配置要求REQUIRED_CONFIG=$(echo "$REDIS_DOCS" | jq -r '.required_fields[]')# 校验你的 AppHost 是否定义了这些字段for field in $REQUIRED_CONFIGdo  grep -q "\"$field\"" apphost.csproj || echo "Missing: $field"done

例子简单,但模式很强大✅ 你的 CI 现在能程序化访问 Aspire 集成的权威数据源。不用过时快照。


📊 输出格式:人类 × 机器,各取所需

每个命令都支持两种输出格式,毕竟不是所有消费者都有眼睛👀:

默认(人类友好):干净 Markdown,终端阅读友好。颜色和换行由你的终端控制。

aspire docs get redis-integration

JSON(机器友好):结构化 JSON,含元数据——完整页面内容、章节结构、相关链接。

aspire docs get redis-integration --format Json

JSON 输出让构建自定义文档工具、索引器、知识库变得超简单。同一份数据,不同接口🎯

🔄 文档永远在线实时。aspire.dev 一更新,CLI 和基于它构建的任何 Skill/自动化都能同步反映。你不是在下载快照,而是在查询真实文档源(带 ETag 缓存加速性能✨)


🎉 一句话总结

Aspire 13.2 的文档工具链,解决了一个真实痛点:人类和 AI 助手都需要最新、官方的指导,但靠浏览器标签 + 模型过时记忆,体验真的拉胯😤

通过把 Aspire 文档封装成简单 CLI + 可复用工具,我们让文档变成:✅ 终端里直接用的利器✅ Skills 和自动化脚本能插拔的模块

同一索引、同一搜索、同一权威源,人和工具,双赢🤝

现在就开始:先直接试 CLI,再把它接入你已有的 Skill 或自动化流程:

aspire docs search "your-topic-here"

就这么简单。现在,去构建点酷东西吧——顺便给你的工具也配上文档🚀


📌 关注本号,获取更多 .NET 技术实战指南👇 点赞+推荐+分享,让更多开发者少走弯路!