Starlens 用户文档
Starlens 是一个面向 GitHub Stars 的个人知识工作台。它会把收藏仓库同步到你自己的 PostgreSQL 数据库,补充标签、备注、摘要和检索文本,再通过 Web 工作台、AI 问答、CLI、HTTP API 和 Cursor MCP 工具提供统一入口。
快速安装与体验(Agent Skill + MCP)
Skill 是最轻量的行为说明层,适合 Claude Code、Cursor、VS Code、OpenClaw、Hermes 等支持 Skill 文件的客户端。stars setup 会先通过 npx skills add 安装 Skill,再引导你为支持的客户端配置 MCP。
推荐使用 CLI 一键安装:
npm install -g @starlens-app/cli@latest
stars setup
如果 Skill 已经安装,只需要配置 MCP,请运行 stars install-mcp。如果只需要 Skill、不需要 MCP,可以直接运行 npx skills add https://github.com/yuanyang749/starlens。
适合谁使用
- GitHub Stars 数量很多,需要更快找回项目的开发者。
- 希望用标签、备注和 AI 摘要整理开源项目的人。
- 希望让 CLI、Agent 或内部工具检索自己收藏仓库的团队。
能解决什么问题
| 场景 | Starlens 提供的能力 |
|---|---|
| 忘记仓库名称,只记得用途 | 使用仓库描述、README 摘要、主题、标签和备注做联合搜索 |
| 想把 Stars 分成长期知识库 | 给仓库添加个人标签、备注和重点收藏状态 |
| 想让 AI 基于自己的 Stars 回答 | 先搜索候选仓库,再调用已配置的 AI Provider 生成回答 |
| 想给 Agent 使用收藏库 | 通过个人 API Token 调用 HTTP API |
| 想自托管数据 | 使用 PostgreSQL 和 GitHub OAuth,在自有服务器部署 |
文档内容
- 功能说明:了解仓库搜索、筛选、标签、备注、收藏和 AI 问答。
- 技术架构:了解 Web 应用、数据库、同步任务和 AI 能力的模块划分。
- 对接配置:了解 GitHub OAuth、API Token、AI Provider、CLI 和 MCP 的配置方式。
- 部署方式:了解本地开发、Docker 自托管和 Node.js 自托管的基础流程。
推荐阅读顺序
如果你只是想部署并试用,先看部署方式,再看对接配置。如果你要二次开发,先看技术架构,再看功能说明和接口约定。
快速启动路径
- 创建 GitHub OAuth App,并把回调地址指向
NEXTAUTH_URL/api/auth/callback/github。 - 准备 PostgreSQL,配置
DATABASE_URL、AUTH_SECRET、AUTH_GITHUB_ID和AUTH_GITHUB_SECRET。 - 执行数据库迁移并启动 Web 应用。
- 登录后触发一次 Stars 同步。
- 在工作台中搜索、筛选、添加标签和备注。
- 在设置页配置 AI Provider,或在 Tokens 页面创建 CLI / Agent Token。
