实用工具

AI README 生成器

零散的项目笔记进去,出来一份带安装、用法和参数表的完整 README.md。

自带 Key 或官方托管AI 助手1.1万
去哪里获取 Key

Key 只在你的浏览器里。Key 由浏览器直接发送给服务商,不经过我们的服务器,我们不记录也不保存。建议使用专门创建、设了额度上限的 Key,用完及时到服务商后台删除。

输入

结果

结果会显示在这里。

大多数项目的 README 只写了一句“TODO”。把手头有的东西都贴进来——一句项目介绍、package.json、命令行的 --help 输出、常用命令列表——就能得到一份完整的 README.md:标题和简介、徽章、功能、环境要求、安装、带可复制示例的用法、参数表、开发、贡献和许可证。章节顺序参考了流行的 README 脚手架 kefranabg/readme-md-generator,区别是不用一问一答地填它的问题。

它是怎么工作的

  • 笔记里没写的信息——仓库地址、版本号、许可证——会留下显眼的 <!-- TODO --> 占位,而不是编一个看似真实的值。
  • 笔记里出现的命令行参数、配置项和环境变量会整理成“参数、默认值、说明”三列的表格。
  • 笔记用中文写,也可以要一份英文 README,反过来也行;命令和代码永远不会被翻译。

你的数据去了哪里

使用自带 Key 时,你输入的内容和 Key 由浏览器直接发送给你选择的 AI 服务商,不经过 hysenlabs 的服务器。使用官方托管时,内容经我们的服务器转发给我们的服务商(DeepSeek),按 credits 计费;我们只记录每次运行的 Token 数和成本用于计费,从不保存你输入的内容和返回的结果。服务商如何处理这些内容,以它自己的隐私政策为准。

本工具会接触密钥和凭证,因此任何一次运行都不会被保存,连你自己的历史里也不会有。

关于你的 API Key

我们承诺不会收集、存储或泄露你的 Key:它只保存在当前页面的内存里(除非你勾选“在本标签页记住”),关闭页面即消失。但任何 Key 一旦在网页里用过,都值得多一分小心——建议专门为这里创建一个设了额度上限的 Key,用完后及时到服务商后台删除或轮换。

它要花多少

本工具完全免费,不需要登录,也不消耗积分。

常见问题

会不会编造功能或徽章?
提示词明确禁止,缺的信息一律留占位。徽章只针对笔记里能确认的东西添加,比如 npm 包名或许可证,使用 shields.io 地址;不想要徽章可以把开关关掉。
贴什么内容效果最好?
项目清单文件(package.json、pyproject.toml 或 Cargo.toml)、--help 的输出,再加一句这个项目是给谁用的。有了真实的参数名和安装命令,README 才会既整齐又准确。
我的笔记和 Key 会去哪里?
从这个页面用你的 Key 直接发给你选的模型服务商,hysenlabs.com 什么都不留。还没公开的项目,请用你认可其条款的服务商,专门建一个 Key,用完就删。

背后的开源项目

本工具是独立实现,并未打包第三方库。kefranabg/readme-md-generator(MIT)在代码层面做的是同一件事——如果你需要在自己的程序里实现它,从那里开始,而不是调用一个网页。

kefranabg/readme-md-generator

也常被称作

  • readme生成器
  • ai写readme
  • readme模板
  • github readme怎么写
  • readme.md生成