followanton/sleepwalker

GitHub: followanton/sleepwalker

Sleepwalker 是一个 AI 可见性与内容智能服务,帮助团队监控和优化品牌在主流 AI 搜索引擎中的表现与引用情况。

Stars: 15 | Forks: 0

Sleepwalker

CI MIT CLI npm version Zero dependencies MCP ready

面向代理、产品和团队的 AI 可见性与内容智能服务。
运行 AI 搜索检查,检查引用,评估内容得分,并将所有结果保存在同一个工作区中。

官网 · 应用 · 文档 · MCP · API · CLI · 指南

Sleepwalker 帮助团队了解 AI 系统如何谈论某个品牌,以及哪些内容需要修改。它结合了两个相互关联的工作流: - **AI 可见性**:在 ChatGPT、Perplexity、Grok 和 Gemini 上运行 prompt;捕获完整的回答、引用、竞争对手和提及类型。 - **内容智能**:将公开页面序列化,发现需求,评估内容的深度和新鲜度,并返回实用的建议。 你可以通过托管应用、公开 API、MCP 客户端或 CLI 执行相同的工作。结果是相互关联的,因此由代理启动的运行可以稍后在应用中查看或通过代码查询。 此仓库是 Sleepwalker 的公开开发者界面:包含 CLI 包、API 示例、MCP 设置说明和简短指南。托管的引擎、应用源代码、数据库 schema、提供商集成和计费系统均为私有。 ## 快速开始 无需注册账户即可先试用 CLI。`okf export` 是免费且开源的。它在你的机器上运行,获取页面,并将适配 agent 的 markdown 包写入本地文件夹。无需 API key,无需额度: ``` npx -y @sleepwalkerai/cli okf export https://www.sleepwalker.ai ``` 如需执行其他所有操作,请安装 CLI: ``` npm install -g @sleepwalkerai/cli sleepwalker init ``` 在 [Sleepwalker 应用](https://app.sleepwalker.ai)中创建 API key,然后运行你的首次可见性检查: ``` sleepwalker auth key set sw_api_live_... sleepwalker doctor sleepwalker visibility run https://yourbrand.com \ --brand YourBrand \ --prompt "best ai visibility platform 2026" \ --platform perplexity,openai,grok,gemini \ --watch ```

Sleepwalker CLI running an AI Visibility check

想先看看数据的结构?打开 [`docs/responses.md`](docs/responses.md) 查看序列化、prompt 建议、AI 可见性、内容智能和报告查询的完整示例输出。 ## 你可以构建什么

Sample AI Visibility result across platforms

- **AI 搜索 (GEO) 监控**:设置跨 ChatGPT、Perplexity、Grok 和 Gemini 对特定 URL 的 prompt 跟踪。 - **代理工作流**:让 Claude 等 MCP 客户端访问 LLM 回答、引用的域名、竞争对手表现和内容趋势。 - **产品集成**:在内部工具、客户门户、报告 pipeline 或自动化 QA 检查中使用 API。 - **内容审查**:检查页面的内容、错过的趋势,以及需要优先修复的问题。 - **免费页面导出**:使用 `okf export` 将任何公开页面转换为适配 agent 的 markdown。开源,在本地运行,无需账户。 - **自定义工作流**:将 Sleepwalker 与其他 MCP server 结合使用,构建你自己的技能和自动化流程。 ## 访问路径 | 界面 | 最适合 | 入口 | |---|---|---| | 应用 | 人工审查、额度、key 和完整结果视图 | [app.sleepwalker.ai](https://app.sleepwalker.ai) | | API | 脚本、产品、定时任务和报告工作流 | [API 文档](https://www.sleepwalker.ai/docs/api/) | | MCP | Claude 和其他支持 MCP 的 agent | [MCP 设置](https://www.sleepwalker.ai/docs/mcp/) | | CLI | 终端工作流和自动化 | [CLI 文档](https://www.sleepwalker.ai/docs/cli/) |

Sleepwalker action flow across app, API, MCP, and CLI

## 从任何地方运行 Sleepwalker **CLI** ``` sleepwalker visibility run https://yourbrand.com \ --brand YourBrand \ --prompt "best ai visibility platform 2026" \ --platform perplexity,openai,grok,gemini \ --watch ``` **API** ``` curl -s https://api.sleepwalker.ai/v1/visibility/runs \ -H "Authorization: Bearer $SLEEPWALKER_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "url": "https://yourbrand.com", "target_entity": "YourBrand", "prompts": ["best ai visibility platform 2026"], "platforms": ["perplexity","openai","grok","gemini"] }' ``` **MCP** ``` https://mcp.sleepwalker.ai/mcp ``` 向支持 MCP 的客户端提问:`检查 YourBrand 本周在 AI 搜索中的表现。` **应用** 打开 [app.sleepwalker.ai](https://app.sleepwalker.ai) 以使用可视化工作流、已保存的结果、额度和 key。 ## 开发者资源 | 路径 | 内容说明 | |---|---| | [`docs/agents.md`](docs/agents.md) | MCP 工具目录和代理工作流演示 | | [`docs/concepts.md`](docs/concepts.md) | 运行、探测、序列化、评分、额度 | | [`docs/cli.md`](docs/cli.md) | CLI 用法,包括免费的本地 `okf export` | | [`docs/cookbook.md`](docs/cookbook.md) | 可运行的工作流,包括 CI 检查 | | [`docs/responses.md`](docs/responses.md) | Sleepwalker 主要操作的完整示例输出 | | [`mcp/server.json`](mcp/server.json) | 远程 MCP server 清单 | | [`mcp/tools.json`](mcp/tools.json) | 公开的 MCP 工具目录、scope 和额度行为 | | [`examples/api/curl`](examples/api/curl) | 公开 API 操作的单次调用示例 | | [`examples/api/javascript`](examples/api/javascript) | 原生 `fetch` 及零依赖客户端辅助程序 | | [`examples/api/python`](examples/api/python) | `urllib` 示例及小型客户端类 | | [`examples/mcp`](examples/mcp) | OAuth 和 bearer token 设置说明 | ## 仓库边界 此仓库特意保持精简。 | 此处公开 | 在 Sleepwalker 中为私有 | |---|---| | CLI、示例、设置说明、简短文档 | 托管引擎和应用源代码 | | 公开 API 请求结构 | MCP server 实现 | | MCP 客户端连接示例 | 数据库 schema 和计费内部结构 | | 产品级额度行为 | 提供商集成和路由 | 请勿提交真实的 key。请使用环境变量或 CLI 的 key 存储区: ``` export SLEEPWALKER_API_KEY=sw_api_live_... ``` ## 链接 - 官网:[sleepwalker.ai](https://www.sleepwalker.ai/) - 应用:[app.sleepwalker.ai](https://app.sleepwalker.ai) - 文档:[sleepwalker.ai/docs](https://www.sleepwalker.ai/docs/) - npm:[@sleepwalkerai/cli](https://www.npmjs.com/package/@sleepwalkerai/cli) - 安全政策:[SECURITY.md](SECURITY.md) - 贡献指南:[CONTRIBUTING.md](CONTRIBUTING.md) - 许可证:[MIT](LICENSE)
标签:AI可见性, MCP, MITM代理, SEO, 代码示例, 内容智能, 数据分析, 文档结构分析, 暗色界面, 自定义脚本