byfranke/sheep

# Sheep 文档 Sheep 生态系统的公开文档。 Sheep 是一个由 AI 辅助的网络威胁情报平台。该平台集成了 HTTP API、命令行工具、按需简报门户以及运行在 Discord 内部的 Bot。 ## 导航 文档按产品进行划分。请根据您的目标选择相应的页面开始阅读。 `getting-started.md` : 初次接触。介绍如何创建账户、生成 token 以及首次调用 API。如果您从未使用过 Sheep，请从这里开始。 `sheep-bot/` : Sheep Discord Bot。包含 slash commands 的完整列表、feed 配置、Sheep Listener、排名以及通过 Discord 的 membership。 `sheep-api/` : Sheep API 手册。包含身份验证、计划、模型、endpoint、限制和集成示例。适用于构建与 SOC、SOAR、SIEM、内部脚本或第三方产品的集成。 `sheep-pulse/` : 按需 CTI 简报。介绍如何通过门户生成 Pulse、配置个人资料以及通过电子邮件或 webhook 接收。 `sheep-cli/` : 适用于本地终端和 pipeline 的 Sheep 官方命令行工具。 `CHANGELOG.md` : 面向公开集成的重要变更，按日期和范围分类整理。 ## 本文档约定 所有代码块均使用虚构数据。其中的 token、电子邮件和标识符均不对应真实账户。 Endpoint 始终以绝对 URL 的形式展示。公开基础 URL 为 `https://sheep.byfranke.com`。目前没有备用主机、镜像或 sandbox 环境。 本文档仅描述公开接口。不在此手册范围内的管理类、内部 endpoint 及相关操作不支持外部使用。 ## 支持 用于讨论和技术疑问的公开社区：`https://sheep.byfranke.com/discord`。 商业事务、安全事件或正式请求：`https://byfranke.com/#Contact`。 ## 许可证 请参阅 `LICENSE.txt`。

标签：AI, Briefings, Chatbot, CLI, Discord机器人, HTTP API, IOC分析, Python脚本, SOAR, TCP/IP协议栈, Webhook, WiFi技术, 人工智能, 力导向图, 失陷标示, 威胁情报分析, 密码管理, 情报通报, 文档结构分析, 用户模式Hook绕过, 网络威胁情报, 网络安全, 网络安全平台, 自动化代码审查, 隐私保护, 集成