Docs Squirrel 是一个人工智能代理,能够为任何规模的代码库以及任何编程语言和框架编写文档。<p>由于不断的变化、时间限制以及该领域所需的专业语言,许多公司在创建和维护最新的技术文档方面面临困难。<p>使用 Docs Squirrel,您无需再担心文档编写的问题,可以专注于推出新功能,而 Docs Squirrel 会为您编写和管理代码库的文档。<p>Docs Squirrel 可以生成以下文档:
个人项目代码库
库、SDK 和框架
公司代码库等<p>工作原理
您选择包含项目代码库的仓库,然后选择要生成的文档类型(技术文档、入职文档、结构文档、文件内注释),接着选择输出模板(单页 Markdown、多页 Markdown、Docusaurus、HTML、MkDocs 或 Docsify),然后它将在几分钟内为您生成所需的文档,且可以使用您选择的语言。<p>此外,您还可以为同一代码库创建新版本,例如,您可以决定将文件内注释作为第一个版本,然后生成技术文档作为第二个版本,接着再创建其他语言(如日语、韩语、希腊语、约鲁巴语和中文)的技术文档版本。<p>常见问题
在 Docs Squirrel 理解您的代码库之前,您需要在代码库中包含 README 吗?
不需要,Docs Squirrel 是一个人工智能代理,它使用 RAG 技术来读取和理解您的代码库。即使您的代码库混乱且变量命名不清晰,它也能理解。<p>我可以生成什么类型的文档?
目前您可以生成以下文档:
1. 技术文档:开发者使用文档,适用于库、框架和 SDK。
2. 入职文档:为新员工准备的文档,帮助他们快速熟悉代码库。
3. 结构文档:目录结构、函数和类定义。
4. 文件内注释:与其他文档类型不同,此类型会在您的代码库中所有代码文件中添加内联注释,同时保持您的代码和现有注释不变。<p>我可以选择哪些文档模板?
目前,Docs Squirrel 支持生成以下模板和框架:
1. 单页 Markdown
2. 多页 Markdown
3. Docusaurus
4. HTML(多页)
5. MkDocs
6. Docsify<p>我可以下载文档吗?
可以,您可以将文档下载为 ZIP、TAR 和 TAR.GZ 格式,此外,您还可以将其发布到新的或现有的 GitHub 仓库中。
返回首页
最新
Ralph-template 是一个用于运行自主 AI 任务的简约设置。<p>您可以在 Markdown 规格中定义需求,将任务列为复选框,并运行一个 shell 脚本。AI 将逐一处理这些任务。<p>特点:每次迭代都会重新初始化上下文。与其累积对话历史直到代理混淆,不如每次循环都从头开始。代理读取规格,完成一项任务后退出。<p>开箱即用,兼容 Claude Code 和 OpenCode。除了 AI CLI 工具本身外,无需其他依赖。<p>示例用例:我需要处理 50 个文件,进行相同的转换。只需定义一次规格,将所有文件列为任务,然后运行循环。<p><a href="https://github.com/bernatsampera/ralph-template" rel="nofollow">https://github.com/bernatsampera/ralph-template</a>
我花不到4美元买了一个VPS,足够大可以托管我多个小项目。我需要一个非常简单的方法来在同一台机器上部署所有项目,并且支持SSL。因此,我创建了它。
```
docklift init # 提供主机信息和域名
docklift deploy
```
就这样。
嗨,HN,我正在构建 Whisper([https://usewhisper.dev](https://usewhisper.dev)),这是一款 AI 代码审查工具,能够进行代码质量和安全分析。它追踪执行流程,捕捉 SQL 注入、身份验证绕过和竞争条件等标准 PR 审查者常常遗漏的问题。
<p>问题</p>
AI 代码审查工具能够发现样式问题,而安全扫描器仅检查依赖项。但您代码中的逻辑安全缺陷却常常被忽视。比如,用户输入在到达数据库之前经过三个函数而导致的 SQL 注入;支付处理中的竞争条件;隐藏在中间件中的身份验证绕过。
<p>我曾经发布过这些漏洞。您的 PR 审查者说“看起来不错”。您的安全扫描器显示通过(反正只检查依赖项)。两周后,渗透测试人员发现了在 PR 中一直可见的漏洞。
<p>为什么要与资金充足的初创公司竞争?</p>
这是个合理的问题。Greptile 融资数百万,Codacy、SonarQube 和 Snyk 都是行业巨头。我的观点是:他们解决的是错误的问题。
<p>大多数 AI 审查工具只是带有 GPT 的代码检查工具。它们查看差异并评论样式。安全扫描器要么只检查依赖项,要么产生 1000 多个误报。那些同时做两者的?是不同的产品,彼此之间没有沟通。
<p>我正在构建不同的东西:具有语义理解的执行流程追踪。Whisper 从用户输入追踪数据,通过您的逻辑找到它到达敏感操作的地方。
<p>大型企业无法轻易复制这一点。它们基于模式匹配构建,而追踪执行流程需要不同的架构。我有以下优势:
- 速度:我在几天内推出功能,而他们需要经过企业合规流程
- 专注:解决一个问题(PR 中的安全性)而不是面面俱到
- 定价:每位开发者 30 美元,而他们的企业模式是每个座位 100-300 美元
- 开发体验:2 分钟设置,而他们需要 45 分钟的企业入职培训
<p>他们优化企业合同,而我优化希望 PR 不再发布漏洞的开发者。
<p>工作原理</p>
示例:标准审查者说“看起来不错”
```javascript
const user = await getUser(req.headers.auth);
const data = await db.query(
`DELETE FROM users WHERE id = ${user.id}`
);
```
<p>Whisper 从 JWT 负载追踪 user.id,通过 getUser() 到 SQL 模板字面量。标记 SQL 注入,并建议使用参数化查询。
<p>竞争条件示例:
```javascript
async function processPayment(userId, amount) {
const balance = await getBalance(userId);
if (balance >= amount) {
await charge(userId, amount);
await updateBalance(userId, balance - amount);
}
}
```
<p>Whisper 发现并发请求可能导致检查和更新之间的双重收费。
<p>状态</p>
目前处于私有测试阶段,已有早期工程团队参与。分析了超过 240 万行代码,捕获了 1247 个漏洞,平均扫描时间为 47 秒。支持所有主要语言,并对 Next.js、React 和 tRPC 有深入的框架理解。
<p>我想要的</p>
希望获得来自以下工程师的反馈:
- 被扫描器的误报淹没
- 不断发布在 PR 中可见的漏洞
- 认为在这里竞争是疯狂的(告诉我为什么!)
<p>我主要是独立开发,没有风险投资。只是解决我一直遇到的问题。
<p>免费试用:[https://usewhisper.dev](https://usewhisper.dev)
嗨,HN
我创建了 DownloadStuffs,这是一个快速、现代的界面,用于探索互联网档案馆。
默认的互联网档案馆用户界面功能强大,但我常常发现它存在以下问题:
- 在移动设备上速度较慢
- 难以预览多个文件的项目(系列、播放列表)
- 下载大文件时不可靠(CORS、链接失效、不清楚“最佳文件”)
因此,我制作了一个更简洁、更具个性的替代方案。
它的功能包括:
- 快速搜索,支持真实的服务器端分页
- 按媒体类型过滤 + 按相关性、下载量、观看次数、最近更新排序
- 页面内视频/音频预览,并支持播放列表队列
- 可靠的下载代理(避免浏览器/CORS问题)
- 批量/播放列表 ZIP 下载,适用于系列和收藏
- 现场演示: [https://downloadstuffss.vercel.app/](https://downloadstuffss.vercel.app/)
技术栈:Bun + TypeScript + Vite + Vercel
仅使用公共互联网档案馆 API(与 IA 无关)。
我非常希望能收到反馈、边缘案例或改进大型公共档案用户体验的想法。
谢谢!
— Dawit