[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"similar-eli64s--readme-ai":3,"tool-eli64s--readme-ai":64},[4,17,27,35,43,56],{"id":5,"name":6,"github_repo":7,"description_zh":8,"stars":9,"difficulty_score":10,"last_commit_at":11,"category_tags":12,"status":16},3808,"stable-diffusion-webui","AUTOMATIC1111\u002Fstable-diffusion-webui","stable-diffusion-webui 是一个基于 Gradio 构建的网页版操作界面，旨在让用户能够轻松地在本地运行和使用强大的 Stable Diffusion 图像生成模型。它解决了原始模型依赖命令行、操作门槛高且功能分散的痛点，将复杂的 AI 绘图流程整合进一个直观易用的图形化平台。\n\n无论是希望快速上手的普通创作者、需要精细控制画面细节的设计师，还是想要深入探索模型潜力的开发者与研究人员，都能从中获益。其核心亮点在于极高的功能丰富度：不仅支持文生图、图生图、局部重绘（Inpainting）和外绘（Outpainting）等基础模式，还独创了注意力机制调整、提示词矩阵、负向提示词以及“高清修复”等高级功能。此外，它内置了 GFPGAN 和 CodeFormer 等人脸修复工具，支持多种神经网络放大算法，并允许用户通过插件系统无限扩展能力。即使是显存有限的设备，stable-diffusion-webui 也提供了相应的优化选项，让高质量的 AI 艺术创作变得触手可及。",162132,3,"2026-04-05T11:01:52",[13,14,15],"开发框架","图像","Agent","ready",{"id":18,"name":19,"github_repo":20,"description_zh":21,"stars":22,"difficulty_score":23,"last_commit_at":24,"category_tags":25,"status":16},1381,"everything-claude-code","affaan-m\u002Feverything-claude-code","everything-claude-code 是一套专为 AI 编程助手（如 Claude Code、Codex、Cursor 等）打造的高性能优化系统。它不仅仅是一组配置文件，而是一个经过长期实战打磨的完整框架，旨在解决 AI 代理在实际开发中面临的效率低下、记忆丢失、安全隐患及缺乏持续学习能力等核心痛点。\n\n通过引入技能模块化、直觉增强、记忆持久化机制以及内置的安全扫描功能，everything-claude-code 能显著提升 AI 在复杂任务中的表现，帮助开发者构建更稳定、更智能的生产级 AI 代理。其独特的“研究优先”开发理念和针对 Token 消耗的优化策略，使得模型响应更快、成本更低，同时有效防御潜在的攻击向量。\n\n这套工具特别适合软件开发者、AI 研究人员以及希望深度定制 AI 工作流的技术团队使用。无论您是在构建大型代码库，还是需要 AI 协助进行安全审计与自动化测试，everything-claude-code 都能提供强大的底层支持。作为一个曾荣获 Anthropic 黑客大奖的开源项目，它融合了多语言支持与丰富的实战钩子（hooks），让 AI 真正成长为懂上",140436,2,"2026-04-05T23:32:43",[13,15,26],"语言模型",{"id":28,"name":29,"github_repo":30,"description_zh":31,"stars":32,"difficulty_score":23,"last_commit_at":33,"category_tags":34,"status":16},2271,"ComfyUI","Comfy-Org\u002FComfyUI","ComfyUI 是一款功能强大且高度模块化的视觉 AI 引擎，专为设计和执行复杂的 Stable Diffusion 图像生成流程而打造。它摒弃了传统的代码编写模式，采用直观的节点式流程图界面，让用户通过连接不同的功能模块即可构建个性化的生成管线。\n\n这一设计巧妙解决了高级 AI 绘图工作流配置复杂、灵活性不足的痛点。用户无需具备编程背景，也能自由组合模型、调整参数并实时预览效果，轻松实现从基础文生图到多步骤高清修复等各类复杂任务。ComfyUI 拥有极佳的兼容性，不仅支持 Windows、macOS 和 Linux 全平台，还广泛适配 NVIDIA、AMD、Intel 及苹果 Silicon 等多种硬件架构，并率先支持 SDXL、Flux、SD3 等前沿模型。\n\n无论是希望深入探索算法潜力的研究人员和开发者，还是追求极致创作自由度的设计师与资深 AI 绘画爱好者，ComfyUI 都能提供强大的支持。其独特的模块化架构允许社区不断扩展新功能，使其成为当前最灵活、生态最丰富的开源扩散模型工具之一，帮助用户将创意高效转化为现实。",107662,"2026-04-03T11:11:01",[13,14,15],{"id":36,"name":37,"github_repo":38,"description_zh":39,"stars":40,"difficulty_score":23,"last_commit_at":41,"category_tags":42,"status":16},3704,"NextChat","ChatGPTNextWeb\u002FNextChat","NextChat 是一款轻量且极速的 AI 助手，旨在为用户提供流畅、跨平台的大模型交互体验。它完美解决了用户在多设备间切换时难以保持对话连续性，以及面对众多 AI 模型不知如何统一管理的痛点。无论是日常办公、学习辅助还是创意激发，NextChat 都能让用户随时随地通过网页、iOS、Android、Windows、MacOS 或 Linux 端无缝接入智能服务。\n\n这款工具非常适合普通用户、学生、职场人士以及需要私有化部署的企业团队使用。对于开发者而言，它也提供了便捷的自托管方案，支持一键部署到 Vercel 或 Zeabur 等平台。\n\nNextChat 的核心亮点在于其广泛的模型兼容性，原生支持 Claude、DeepSeek、GPT-4 及 Gemini Pro 等主流大模型，让用户在一个界面即可自由切换不同 AI 能力。此外，它还率先支持 MCP（Model Context Protocol）协议，增强了上下文处理能力。针对企业用户，NextChat 提供专业版解决方案，具备品牌定制、细粒度权限控制、内部知识库整合及安全审计等功能，满足公司对数据隐私和个性化管理的高标准要求。",87618,"2026-04-05T07:20:52",[13,26],{"id":44,"name":45,"github_repo":46,"description_zh":47,"stars":48,"difficulty_score":23,"last_commit_at":49,"category_tags":50,"status":16},2268,"ML-For-Beginners","microsoft\u002FML-For-Beginners","ML-For-Beginners 是由微软推出的一套系统化机器学习入门课程，旨在帮助零基础用户轻松掌握经典机器学习知识。这套课程将学习路径规划为 12 周，包含 26 节精炼课程和 52 道配套测验，内容涵盖从基础概念到实际应用的完整流程，有效解决了初学者面对庞大知识体系时无从下手、缺乏结构化指导的痛点。\n\n无论是希望转型的开发者、需要补充算法背景的研究人员，还是对人工智能充满好奇的普通爱好者，都能从中受益。课程不仅提供了清晰的理论讲解，还强调动手实践，让用户在循序渐进中建立扎实的技能基础。其独特的亮点在于强大的多语言支持，通过自动化机制提供了包括简体中文在内的 50 多种语言版本，极大地降低了全球不同背景用户的学习门槛。此外，项目采用开源协作模式，社区活跃且内容持续更新，确保学习者能获取前沿且准确的技术资讯。如果你正寻找一条清晰、友好且专业的机器学习入门之路，ML-For-Beginners 将是理想的起点。",84991,"2026-04-05T10:45:23",[14,51,52,53,15,54,26,13,55],"数据工具","视频","插件","其他","音频",{"id":57,"name":58,"github_repo":59,"description_zh":60,"stars":61,"difficulty_score":10,"last_commit_at":62,"category_tags":63,"status":16},3128,"ragflow","infiniflow\u002Fragflow","RAGFlow 是一款领先的开源检索增强生成（RAG）引擎，旨在为大语言模型构建更精准、可靠的上下文层。它巧妙地将前沿的 RAG 技术与智能体（Agent）能力相结合，不仅支持从各类文档中高效提取知识，还能让模型基于这些知识进行逻辑推理和任务执行。\n\n在大模型应用中，幻觉问题和知识滞后是常见痛点。RAGFlow 通过深度解析复杂文档结构（如表格、图表及混合排版），显著提升了信息检索的准确度，从而有效减少模型“胡编乱造”的现象，确保回答既有据可依又具备时效性。其内置的智能体机制更进一步，使系统不仅能回答问题，还能自主规划步骤解决复杂问题。\n\n这款工具特别适合开发者、企业技术团队以及 AI 研究人员使用。无论是希望快速搭建私有知识库问答系统，还是致力于探索大模型在垂直领域落地的创新者，都能从中受益。RAGFlow 提供了可视化的工作流编排界面和灵活的 API 接口，既降低了非算法背景用户的上手门槛，也满足了专业开发者对系统深度定制的需求。作为基于 Apache 2.0 协议开源的项目，它正成为连接通用大模型与行业专有知识之间的重要桥梁。",77062,"2026-04-04T04:44:48",[15,14,13,26,54],{"id":65,"github_repo":66,"name":67,"description_en":68,"description_zh":69,"ai_summary_zh":69,"readme_en":70,"readme_zh":71,"quickstart_zh":72,"use_case_zh":73,"hero_image_url":74,"owner_login":75,"owner_name":76,"owner_avatar_url":77,"owner_bio":78,"owner_company":79,"owner_location":80,"owner_email":81,"owner_twitter":75,"owner_website":82,"owner_url":83,"languages":84,"stars":101,"forks":102,"last_commit_at":103,"license":104,"difficulty_score":23,"env_os":105,"env_gpu":105,"env_ram":105,"env_deps":106,"category_tags":109,"github_topics":110,"view_count":23,"oss_zip_url":81,"oss_zip_packed_at":81,"status":16,"created_at":131,"updated_at":132,"faqs":133,"releases":163},3373,"eli64s\u002Freadme-ai","readme-ai","README file generator, powered by AI.","readme-ai 是一款专为开发者设计的智能工具，能够自动为代码仓库生成结构清晰、内容详实的 README 文档。只需提供项目路径或代码库链接，它即可利用强大的仓库处理引擎和先进的大语言模型，瞬间产出专业的说明文件。\n\n长期以来，编写和维护高质量的技术文档耗费了开发者大量精力，且容易因人为疏忽导致格式混乱或信息缺失。readme-ai 正是为了解决这一痛点而生，它将繁琐的文档撰写工作自动化，确保项目文档始终符合最佳实践，保持整洁与一致。\n\n这款工具特别适合各类软件工程师、开源项目维护者以及技术团队使用。无论你的项目采用何种编程语言或框架，readme-ai 都能轻松适配。其独特亮点在于极高的灵活性与智能化：用户不仅可以自由切换 OpenAI、Ollama、Anthropic 或 Gemini 等多种大模型后端，还能根据需求定制模板风格与徽章样式。此外，它支持智能文件过滤，甚至具备离线生成模式，让用户在无网络环境下也能高效工作。通过简单的命令行操作，readme-ai 帮助开发者从重复劳动中解放出来，更专注于核心代码的创新与构建。","\u003Cdiv id=\"top\">\n\n\u003Cp align=\"center\">\n\n\u003Cdiv align=\"center\">\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\">\n    \u003Cimg\n      src=\"https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Flogo.svg\" \n      alt=\"ReadmeAI Logo\" width=\"60%\">\n  \u003C\u002Fa>\n\u003C\u002Fdiv>\n\n\u003C!-- \u003Cpicture>\n  \u003Csource media=\"(prefers-color-scheme: dark)\" srcset=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Flogo-gradient.svg\">\n  \u003Csource media=\"(prefers-color-scheme: light)\" srcset=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Flogo-gradient.svg\">\n  \u003Cimg alt=\"ReadmeAI Logo\" src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Flogo-gradient.svg\" width=\"60%\">\n\u003C\u002Fpicture> -->\n\n\u003C\u002Fp>\n\n\u003Cp align=\"center\">\n  \u003Cem>Designed for simplicity, customization, and developer productivity.\u003C\u002Fem>\n\u003C\u002Fp>\n\n\u003Cp align=\"center\">\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Factions\">\n    \u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Factions\u002Fworkflow\u002Fstatus\u002Feli64s\u002Freadme-ai\u002Frelease-pipeline.yml?logo=githubactions&label=CI&logoColor=white&color=4169E1\" alt=\"Github Actions\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fapp.codecov.io\u002Fgh\u002Feli64s\u002Freadme-ai\">\n    \u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fcodecov\u002Fc\u002Fgithub\u002Feli64s\u002Freadme-ai?logo=codecov&logoColor=white&label=Coverage&color=5D4ED3\" alt=\"Test Coverage\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fpypi.python.org\u002Fpypi\u002Freadmeai\u002F\">\n    \u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fpypi\u002Fv\u002Freadmeai?logo=Python&logoColor=white&label=PyPI&color=7934C5\" alt=\"PyPI Version\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fwww.pepy.tech\u002Fprojects\u002Freadmeai\">\n    \u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fpepy\u002Fdt\u002Freadmeai?logo=PyPI&logoColor=white&label=Downloads&color=9400D3\" alt=\"Total Downloads\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fopensource.org\u002Flicense\u002Fmit\u002F\">\n    \u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Flicense\u002Feli64s\u002Freadme-ai?logo=opensourceinitiative&logoColor=white&label=License&color=8A2BE2\" alt=\"MIT License\">\n  \u003C\u002Fa>\n\u003C\u002Fp>\n\n\u003C\u002Fdiv>\n\n\u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Feb2a0b4778c633911303f3c00f87874f398b5180\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Fline-gradient.svg\" alt=\"line break\" width=\"100%\" height=\"3px\">\n\n## Quick Links\n\n- [Intro](#introduction)\n- [Demo](#demo)\n- [Features](#features)\n- [Quickstart](#getting-started)\n- [Configuration](#configuration)\n- [Example Gallery](#example-gallery)\n- [Contributing Guidelines](#contributing)\n\n> [!IMPORTANT]\n> Explore the [Official Documentation][docs] for a complete list of features, customization options, and examples.\n\n\u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Feb2a0b4778c633911303f3c00f87874f398b5180\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Fline-gradient.svg\" alt=\"line break\" width=\"100%\" height=\"3px\">\n\n## Introduction\n\nReadmeAI is a developer tool that automatically generates README files using a robust repository processing engine and advanced language models. Simply provide a URL or path to your codebase, and a well-structured and detailed README will be generated.\n\n**Why Use ReadmeAI?**\n\nThis project aims to streamline the process of creating and maintaining documentation across all technical disciplines and experience levels. The core principles include:\n\n- **🔵 Automate:** Generate detailed and structured README files with a single command.\n- **⚫️ Customize:** Select from a variety of templates, styles, badges, and much more.\n- **🟣 Flexible:** Switch between `OpenAI`, `Ollama`, `Anthropic`, and `Gemini` anytime.\n- **🟠 Language Agnostic:** Compatible with a wide range of languages and frameworks.\n- **🟡 Best Practices:** Ensure clean and consistent documentation across all projects.\n- **🟢 Smart Filtering:** Intelligent file analysis with customizable `.readmeaiignore` patterns.\n- **⛔️ Offline Mode:** Create README files offline, without using a LLM API service.\n\n## Demo\n\n**Run from your terminal:**\n\n[readmeai-cli-demo][cli-demo]\n\n\u003C!--\n**Run from your browser:**\n\n[readmeai-streamlit-demo][streamlit-demo]\n-->\n\n\u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Feb2a0b4778c633911303f3c00f87874f398b5180\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Fline-gradient.svg\" alt=\"line break\" width=\"100%\" height=\"3px\">\n\n## Features\n\n### Customize Your README\n\nLet's begin by exploring various customization options and styles supported by ReadmeAI:\n\n\u003Cdiv align=\"left\">\n  \u003Ch6>Header Styles\u003C\u002Fh6>\n  \u003Ctable>\n    \u003C!-- HEADER STYLES: CLASSIC -->\n    \u003Ctr>\n      \u003Ctd align=\"left\">\n        \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_4ae438975d6b.png\"\n             alt=\"Classic Header\"\n             width=\"800\"\n             style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px;\">\n        \u003Cp align=\"left\">\u003Cb>CLI Command:\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\n          \u003Ccode>$ readmeai --repository https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai-streamlit \\\n           --logo custom \\\n           --badge-color FF4B4B \\\n           --badge-style flat-square \\\n           --header-style classic\n          \u003C\u002Fcode>\n        \u003C\u002Fpre>\n      \u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003C!-- HEADER STYLES: MODERN -->\n    \u003Ctr>\n      \u003Ctd align=\"left\">\n        \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_b8f2c4657166.png\"\n             alt=\"Modern Header\"\n             width=\"800\"\n             style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px;\">\n        \u003Cp align=\"left\">\u003Cb>CLI Command:\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\n          \u003Ccode>$ readmeai --repository https:\u002F\u002Fgithub.com\u002Folliefr\u002Fdocker-gs-ping \\\n           --badge-color 00ADD8 \\\n           --badge-style for-the-badge \\\n           --header-style modern \\\n           --navigation-style roman\n          \u003C\u002Fcode>\n        \u003C\u002Fpre>\n      \u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003C!-- HEADER STYLES: COMPACT -->\n    \u003Ctr>\n      \u003Ctd align=\"left\">\n        \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_e13f887a075a.png\"\n          alt=\"Compact Header\"\n          width=\"800\"\n          style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px;\">\n        \u003Cp align=\"left\">\u003Cb>CLI Command:\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\n          \u003Ccode>$ readmeai --repository https:\u002F\u002Fgithub.com\u002Frumaan\u002Ffile.io-Android-Client \\\n           --badge-style plastic \\\n           --badge-color blueviolet \\\n           --logo PURPLE \\\n           --header-style COMPACT \\\n           --navigation-style NUMBER \\\n           --emojis solar\n          \u003C\u002Fcode>\n        \u003C\u002Fpre>\n      \u003C\u002Ftd>\n    \u003C\u002Ftr>\n  \u003C\u002Ftable>\n\n  \u003C!-- HEADER STYLES: BANNERS -->\n  \u003Ch3>Banner Styles\u003C\u002Fh3>\n  \u003Ctable>\n    \u003Ctr>\n      \u003Ctd align=\"left\">\n        \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_f52f25a10eb0.png\"\n          alt=\"Console Header\"\n          width=\"800\"\n          style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px;\">\n        \u003Cp align=\"left\">\u003Cb>CLI Command:\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\n          \u003Ccode>$ readmeai --repository https:\u002F\u002Fgithub.com\u002Femcf\u002Fthepipe \\\n           --badge-style flat-square \\\n           --badge-color 8a2be2 \\\n           --header-style console \\\n           --navigation-style accordion \\\n           --emojis water\n          \u003C\u002Fcode>\n        \u003C\u002Fpre>\n      \u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003C!-- HEADER STYLES: SVG BANNER -->\n    \u003Ctr>\n      \u003Ctd align=\"left\">\n        \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_435859b6bc89.png\"\n          alt=\"SVG Banner\"\n          width=\"800\"\n          style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px;\">\n        \u003Cp align=\"left\">\u003Cb>CLI Command:\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\n          \u003Ccode>$ readmeai --repository https:\u002F\u002Fgithub.com\u002FFerrariDG\u002Fasync-ml-inference \\\n           --badge-style plastic \\\n           --badge-color 43a047 \\\n           --header-style BANNER\n          \u003C\u002Fcode>\n        \u003C\u002Fpre>\n      \u003C\u002Ftd>\n    \u003C\u002Ftr>\n  \u003C\u002Ftable>\n\n  \u003C!-- ADDITIONAL STYLES -->\n  \u003Ch3>And More!\u003C\u002Fh3>\n  \u003Ctable>\n    \u003Ctr>\n      \u003Ctd align=\"left\" style=\"padding: 20px;\">\n        \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_47d4913bd495.png\"\n            alt=\"Project Overview\"\n            width=\"800\"\n            style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px; margin-bottom: 15px;\">\n        \u003Cp align=\"left\" style=\"margin: 10px 0;\">\u003Cb>CLI Command:\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\n          \u003Ccode>$ readmeai --repository 'https:\u002F\u002Fgithub.com\u002Feli64sreadme-ai-streamlit' \\\n           --badge-style FLAT-SQUARE \\\n           --badge-color E92063 \\\n           --header-style COMPACT \\\n           --navigation-style ACCORDION \\\n           --emojis RAINBOW \\\n           --logo ICE\n          \u003C\u002Fcode>\n        \u003C\u002Fpre>\n      \u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003C!-- -->\n    \u003Ctr>\n      \u003Ctd align=\"left\" style=\"padding: 20px;\">\n        \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_84893724fe37.png\"\n            alt=\"Custom Logo\"\n            width=\"800\"\n            style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px; margin-bottom: 15px;\">\n        \u003Cp align=\"left\" style=\"margin: 10px 0;\">\u003Cb>CLI Command:\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\n          \u003Ccode>$ readmeai --repository https:\u002F\u002Fgithub.com\u002Fjwills\u002Fbuenavista \\\n           --align LEFT \\\n           --badge-style FLAT-SQUARE \\\n           --logo CUSTOM\n          \u003C\u002Fcode>\n        \u003C\u002Fpre>\n      \u003C\u002Ftd>\n    \u003C\u002Ftr>\n  \u003C\u002Ftable>\n\n  \u003C!-- -->\n  \u003C!-- \u003Ctable>\n    \u003Ctr>\n      \u003Ctd align=\"left\" width=\"50%\" style=\"padding: 20px;\">\n        \u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Fheaders\u002Fcustom-balloon.png\"\n            alt=\"balloon-logo\"\n            width=\"100%\"\n            style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px; margin-bottom: 15px;\">\n        \u003Cp align=\"left\" style=\"margin: 10px 0;\">\u003Cb>CLI Command:\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\u003Ccode>$ readmeai --repository https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai-streamlit \\\n           --badge-style flat \\\n           --logo custom\u003C\u002Fcode>\u003C\u002Fpre>\n        \u003Cpre align=\"left\" style=\"margin-top: 10px;\">\u003Ccode>$ Provide an image file path or URL: \\\n           https:\u002F\u002Fwww.svgrepo.com\u002Fshow\u002F395851\u002Fballoon.svg\u003C\u002Fcode>\u003C\u002Fpre>\n      \u003C\u002Ftd>\n      \u003Ctd align=\"left\" width=\"50%\" style=\"padding: 20px;\">\n        \u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Fheaders\u002Fskill-icons-light.png\"\n            alt=\"skill-icons\"\n            width=\"100%\"\n            style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px; margin-bottom: 15px;\">\n        \u003Cp align=\"left\" style=\"margin: 10px 0;\">\u003Cb>CLI Command:\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\u003Ccode>$ readmeai --repository https:\u002F\u002Fgithub.com\u002FFerrariDG\u002Fasync-ml-inference \\\n           --badge-style skills-light \\\n           --logo grey\u003C\u002Fcode>\u003C\u002Fpre>\n      \u003C\u002Ftd>\n    \u003C\u002Ftr>\n  \u003C\u002Ftable>\n\n  \u003Ctable>\n    \u003Ctr>\n      \u003Ctd align=\"left\" width=\"50%\" style=\"padding: 20px;\">\n        \u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Fheaders\u002Fcompact.png\"\n            alt=\"compact-header\"\n            width=\"100%\"\n            style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px; margin-bottom: 15px;\">\n        \u003Cp align=\"left\" style=\"margin: 10px 0;\">\u003Cb>CLI Command:\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\u003Ccode>$ readmeai --repository https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai \\\n           --logo cloud \\\n           --header-style compact \\\n           --navigation-style fold\u003C\u002Fcode>\u003C\u002Fpre>\n      \u003C\u002Ftd>\n      \u003Ctd align=\"left\" width=\"50%\" style=\"padding: 20px;\">\n        \u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Frefs\u002Fheads\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Fheaders\u002Fmodern-flat-square.png\"\n            alt=\"modern-style\"\n            width=\"100%\"\n            style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px; margin-bottom: 15px;\">\n        \u003Cp align=\"left\" style=\"margin: 10px 0;\">\u003Cb>CLI Command:\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\u003Ccode>$ readmeai --repository https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai \\\n           -i custom \\\n           -bc BA0098 \\\n           -bs flat-square \\\n           -hs modern \\\n           -ns fold\u003C\u002Fcode>\u003C\u002Fpre>\n      \u003C\u002Ftd>\n    \u003C\u002Ftr>\n  \u003C\u002Ftable> -->\n\u003C\u002Fdiv>\n\n### Generated Sections & Content\n\n\u003Cdetails>\u003Csummary>\u003Cstrong>꩜ Expand to view more!\u003C\u002Fstrong>\u003C\u002Fsummary>\u003Cbr>\n\n| \u003Ch3>Project Introduction\u003C\u002Fh3> \u003Cul>\u003Cli>This section captures your project's essence and value proposition. \u003C\u002Fli>\u003Cli>The prompt template used to generate this section can be viewed [here][prompts.toml]. \u003C\u002Fli>\u003C\u002Ful> |\n| :--- |\n| ![][project-overview] |\n\n| \u003Ch3>Features Table\u003C\u002Fh3> \u003Cul>\u003Cli>Detailed feature breakdown and technical capabilities. \u003C\u002Fli>\u003Cli> The prompt template used to generate this section can be viewed [here][prompts.toml]. \u003C\u002Fli>\u003C\u002Ful> |\n| :--- |\n| ![][features-table] |\n\n| \u003Ch3>Project Structure\u003C\u002Fh3> \u003Cul>\u003Cli>Visual representation of your project's directory structure. \u003C\u002Fli>\u003Cli>The tree is generated using [pure Python][tree.py] and embedded in a code block. \u003C\u002Fli>\u003C\u002Ful> |\n| :--- |\n| ![][project-structure] |\n| \u003Ch3>Project Index\u003C\u002Fh3> \u003Cul>\u003Cli>Summarizes key modules of the project, which are also used as context for downstream [prompts.toml][prompts.toml]. \u003C\u002Fli>\u003C\u002Ful> |\n| ![][project-index] |\n\n| \u003Ch3>Getting Started Guides\u003C\u002Fh3> \u003Cul>\u003Cli>Dependencies and system requirements are extracted from the codebase during preprocessing. \u003C\u002Fli>\u003Cli>The [parsers][readmeai.parsers] handle most of the heavy lifting here. \u003C\u002Fli>\u003C\u002Ful> |\n| :--- |\n| ![][installation-steps] |\n| \u003Ch3>Installation, Usage, & Testing\u003C\u002Fh3> \u003Cul>\u003Cli>Setup instructions and usage guides are automatically created based on data extracted from the codebase. \u003C\u002Fli>\u003C\u002Ful> |\n| ![][usage-guides] |\n\n| \u003Ch3>Community & Support\u003C\u002Fh3> \u003Cul>\u003Cli>Development roadmap, contribution guidelines, license information, and community resources. \u003C\u002Fli>\u003Cli>A \u003Cem>return button\u003C\u002Fem> is also included for easy navigation. \u003C\u002Fli>\u003C\u002Ful> |\n| :--- |\n| ![][community-and-support] |\n| \u003Ch3>Contribution Guides\u003C\u002Fh3> \u003Cul>\u003Cli>Instructions for contributing to the project, including resource links and a basic contribution guide. \u003C\u002Fli>\u003Cli>Graph of contributors is also included for open-source projects. \u003C\u002Fli>\u003C\u002Ful> |\n| ![][contributing-guidelines] |\n\n\u003C\u002Fdetails>\n\n\u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Feb2a0b4778c633911303f3c00f87874f398b5180\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Fline-gradient.svg\" alt=\"line break\" width=\"100%\" height=\"3px\">\n\n## Getting Started\n\n### Prerequisites\n\nReadmeAI requires Python 3.9 or higher, and one of the following installation methods:\n\n| Requirement                          | Details                          |\n|--------------------------------------|----------------------------------|\n| • [Python][python-link] ≥3.9         | Core runtime                     |\n| **Installation Method** (choose one) |                                  |\n| • [pip][pip-link]                    | Default Python package manager   |\n| • [pipx][pipx-link]                  | Isolated environment installer   |\n| • [uv][uv-link]                      | High-performance package manager |\n| • [docker][docker-link]              | Containerized environment        |\n\n### Supported Repository Platforms\n\nTo generate a README file, provide the source repository. ReadmeAI supports these platforms:\n\n| Platform                   | Details                   |\n|----------------------------|---------------------------|\n| [File System][file-system] | Local repository access   |\n| [GitHub][github]           | Industry-standard hosting |\n| [GitLab][gitlab]           | Full DevOps integration   |\n| [Bitbucket][bitbucket]     | Atlassian ecosystem       |\n\n### Supported LLM API Services\n\nReadmeAI is model agnostic, with support for the following LLM API services:\n\n| Provider                          | Best For        | Details                  |\n|-----------------------------------|-----------------|--------------------------|\n| [OpenAI][openai]                  | General use     | Industry-leading models  |\n| [Anthropic][anthropic]            | Advanced tasks  | Claude language models   |\n| [Google Gemini][gemini]           | Multimodal AI   | Latest Google technology |\n| [Ollama][ollama]                  | Open source     | No API key needed        |\n| [Offline Mode][README-Offline.md] | Local operation | No internet required     |\n\n---\n\n### Installation\n\nReadmeAI is available on [PyPI][pypi-link] as readmeai and can be installed as follows:\n\n\u003C!-- #### Using `pip` [![pypi][pypi-shield]][pypi-link] -->\n\u003C!-- #### ![pip][python-svg]{ width=\"2%\" } Pip -->\n#### \u003Cimg width=\"2%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fpython.svg\"> Pip\n\nInstall with pip (recommended for most users):\n\n```sh\n❯ pip install -U readmeai\n```\n\n\u003C!-- #### Using `pipx` [![pipx][pipx-shield]][pipx-link] -->\n\u003C!-- #### ![pipx][pipx-svg]{ width=\"2%\" } Pipx -->\n#### \u003Cimg width=\"2%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fpipx.svg\"> Pipx\n\nWith `pipx`, readmeai will be installed in an isolated environment:\n\n```sh\n❯ pipx install readmeai\n```\n\n\u003C!-- #### ![uv][uv-svg]{ width=\"2%\" } Uv -->\n#### \u003Cimg width=\"2%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fuv.svg\"> Uv\n\nThe fastest way to install readmeai is with [uv][uv-link]:\n\n```sh\n❯ uv tool install readmeai\n```\n\n\u003C!-- #### Using `docker` [![docker][docker-shield]][docker-link] -->\n\u003C!-- #### ![docker][docker-svg]{ width=\"2%\" } Docker -->\n#### \u003Cimg width=\"2%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fdocker.svg\"> Docker\n\nTo run `readmeai` in a containerized environment, pull the latest image from [Docker Hub][dockerhub-link]:\n\n```sh\n❯ docker pull zeroxeli\u002Freadme-ai:latest\n```\n\n\u003C!-- #### ![build-from-source][git-svg]{ width=\"2%\" } From source -->\n#### \u003Cimg width=\"2%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fgit.svg\"> From source\n\n\u003Cdetails>\u003Csummary>\u003Ci>Click to build \u003Ccode>readmeai\u003C\u002Fcode> from source\u003C\u002Fi>\u003C\u002Fsummary>\n\n1. **Clone the repository:**\n\n    ```sh\n    ❯ git clone https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\n    ```\n\n2. **Navigate to the project directory:**\n\n    ```sh\n    ❯ cd readme-ai\n    ```\n\n3. **Install dependencies:**\n\n    ```sh\n    ❯ pip install -r setup\u002Frequirements.txt\n    ```\n\nAlternatively, use the [setup script][setup-script] to install dependencies:\n\n\u003C!-- #### ![bash][bash-svg]{ width=\"2%\" } Bash -->\n##### \u003Cimg width=\"1.5%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fgnubash.svg\"> Bash\n\n1. **Run the setup script:**\n\n    ```sh\n    ❯ bash setup\u002Fsetup.sh\n    ```\n\nOr, use `poetry` to build and install project dependencies:\n\n\u003C!-- #### ![poetry][poetry-svg]{ width=\"2%\" } Poetry -->\n##### \u003Cimg width=\"1.5%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fpoetry.svg\"> Poetry\n\n1. **Install dependencies with poetry:**\n\n    ```sh\n    ❯ poetry install\n    ```\n\n\u003C\u002Fdetails>\n\u003Cbr>\n\n### Additional Optional Dependencies\n\n> [!IMPORTANT]\n> To use the **Anthropic** and **Google Gemini** clients, extra dependencies are required. Install the package with the following extras:\n>\n> - **Anthropic:**\n>   ```sh\n>   ❯ pip install \"readmeai[anthropic]\"\n>   ```\n> - **Google Gemini:**\n>   ```sh\n>   ❯ pip install \"readmeai[google-generativeai]\"\n>   ```\n>\n> - **Install Multiple Clients:**\n>   ```sh\n>   ❯ pip install \"readmeai[anthropic,google-generativeai]\"\n>   ```\n\n### Usage\n\n#### Set your API key\n\nWhen running `readmeai` with a third-party service, you must provide a valid API key. For example, the `OpenAI` client is set as follows:\n\n```sh\n❯ export OPENAI_API_KEY=\u003Cyour_api_key>\n\n# For Windows users:\n❯ set OPENAI_API_KEY=\u003Cyour_api_key>\n```\n\n\u003Cdetails closed>\u003Csummary>Click to view environment variables for - \u003Ccode>Ollama\u003C\u002Fcode>, \u003Ccode>Anthropic\u003C\u002Fcode>, \u003Ccode>Google Gemini\u003C\u002Fcode>\u003C\u002Fsummary>\n\u003Cbr>\n\u003Cdetails closed>\u003Csummary>Ollama\u003C\u002Fsummary>\n\u003Cbr>\n\nRefer to the [Ollama documentation][ollama] for more information on setting up the Ollama server.\n\nTo start, follow these steps:\n\n1. Pull your model of choice from the Ollama repository:\n\n\t```sh\n\t❯ ollama pull llama3.2:latest\n\t```\n\n2. Start the Ollama server and set the `OLLAMA_HOST` environment variable:\n\n\t```sh\n\t❯ export OLLAMA_HOST=127.0.0.1 && ollama serve\n\t```\n\n\u003C\u002Fdetails>\n\u003Cdetails closed>\u003Csummary>Anthropic\u003C\u002Fsummary>\n\n1. Export your Anthropic API key:\n\n\t```sh\n\t❯ export ANTHROPIC_API_KEY=\u003Cyour_api_key>\n\t```\n\n\u003C\u002Fdetails>\n\u003Cdetails closed>\u003Csummary>Google Gemini\u003C\u002Fsummary>\n\n1. Export your Google Gemini API key:\n\n\t```sh\n\t❯ export GOOGLE_API_KEY=\u003Cyour_api_key\n\t```\n\n\u003C\u002Fdetails>\n\u003C\u002Fdetails>\n\n#### Using the CLI\n\n##### Running with a LLM API service\n\nBelow is the minimal command required to run `readmeai` using the `OpenAI` client:\n\n```sh\n❯ readmeai --api openai -o readmeai-openai.md -r https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\n```\n\n> [!IMPORTANT]\n> The default model set is `gpt-3.5-turbo`, offering the best balance between cost and performance.When using any model from the `gpt-4` series and up, please monitor your costs and usage to avoid unexpected charges.\n\nReadmeAI can easily switch between API providers and models. We can run the same command as above with the `Anthropic` client:\n```sh\n❯ readmeai --api anthropic -m claude-3-5-sonnet-20240620 -o readmeai-anthropic.md -r https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\n```\n\nAnd finally, with the `Google Gemini` client:\n\n```sh\n❯ readmeai --api gemini -m gemini-1.5-flash -o readmeai-gemini.md -r https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\n```\n\n##### Running with local models\n\nWe can also run `readmeai` with free and open-source locally hosted models using the Ollama:\n\n```sh\n❯ readmeai --api ollama --model llama3.2 -r https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\n```\n\n##### Running on a local codebase\n\nTo generate a README file from a local codebase, simply provide the full path to the project:\n\n```sh\n❯ readmeai --repository \u002Fusers\u002Fusername\u002Fprojects\u002Fmyproject --api openai\n```\n\nAdding more customization options:\n\n```sh\n❯ readmeai --repository https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai \\\n           --output readmeai.md \\\n           --api openai \\\n           --model gpt-4 \\\n           --badge-color A931EC \\\n           --badge-style flat-square \\\n           --header-style compact \\\n           --navigation-style fold \\\n           --temperature 0.9 \\\n           --tree-depth 2\n           --logo LLM \\\n           --emojis solar\n```\n\n##### Running in offline mode\n\nReadmeAI supports `offline mode`, allowing you to generate README files without using a LLM API service.\n\n```sh\n❯ readmeai --api offline -o readmeai-offline.md -r https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\n```\n\n\u003C!-- #### ![docker][docker-svg]{ width=\"2%\" } Docker -->\n#### \u003Cimg width=\"2%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fdocker.svg\"> Docker\n\nRun the `readmeai` CLI in a Docker container:\n\n```sh\n❯ docker run -it --rm \\\n    -e OPENAI_API_KEY=$OPENAI_API_KEY \\\n    -v \"$(pwd)\":\u002Fapp zeroxeli\u002Freadme-ai:latest \\\n    --repository https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai \\\n    --api openai\n```\n\n\u003C!-- #### ![streamlit][streamlit-svg]{ width=\"2%\" } Streamlit -->\n#### \u003Cimg width=\"2%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fstreamlit.svg\"> Streamlit\n\nTry readme-ai directly in your browser on Streamlit Cloud, no installation required.\n\n[\u003Cimg align=\"center\" src=\"https:\u002F\u002Fstatic.streamlit.io\u002Fbadges\u002Fstreamlit_badge_black_white.svg\" width=\"20%\">](https:\u002F\u002Freadme-ai.streamlit.app\u002F)\n\nSee the [readme-ai-streamlit][readme-ai-streamlit] repository on GitHub for more details about the application.\n\n> [!WARNING]\n> The readme-ai Streamlit web app may not always be up-to-date with the latest features. Please use the command-line interface (CLI) for the most recent functionality.\n\n\u003C!-- #### ![build-from-source][git-svg]{ width=\"2%\" } From source -->\n#### \u003Cimg width=\"2%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fgit.svg\"> From source\n\n\u003Cdetails>\u003Csummary>\u003Ci>Click to run \u003Ccode>readmeai\u003C\u002Fcode> from source\u003C\u002Fi>\u003C\u002Fsummary>\n\n\u003C!-- #### ![bash][bash-svg]{ width=\"2%\" } Bash -->\n##### \u003Cimg width=\"1.5%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fgnubash.svg\"> Bash\n\nIf you installed the project from source with the bash script, run the following command:\n\n1. Activate the virtual environment:\n\n   ```sh\n   ❯ conda activate readmeai\n   ```\n\n2. Run the CLI:\n\n   ```sh\n   ❯ python3 -m readmeai.cli.main -r https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\n\t```\n\n\u003C!-- #### ![poetry][poetry-svg]{ width=\"2%\" } Poetry -->\n##### \u003Cimg width=\"1.5%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fpoetry.svg\"> Poetry\n\n1. Activate the virtual environment:\n\n   ```sh\n   ❯ poetry shell\n   ```\n\n2. Run the CLI:\n\n   ```sh\n   ❯ poetry run python3 -m readmeai.cli.main -r https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\n   ```\n\n\u003C\u002Fdetails>\n\n\u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Feb2a0b4778c633911303f3c00f87874f398b5180\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Fline-gradient.svg\" alt=\"line break\" width=\"100%\" height=\"3px\">\n\n### Testing\n\n\u003C!-- #### Using `pytest` [![pytest][pytest-shield]][pytest-link] -->\n\nThe [pytest][pytest-link] and [nox][nox-link] frameworks are used for development and testing.\n\nInstall the dependencies with uv:\n\n```sh\n❯ uv pip install --dev --group test --all-extras\n```\n\nRun the unit test suite using Pytest:\n\n```sh\n❯ make test\n```\n\nUsing nox, test the app against Python versions `3.9`, `3.10`, `3.11`, and `3.12`:\n\n```sh\n❯ make test-nox\n```\n\n> [!TIP]\n> \u003Csub>Nox is an automation tool for testing applications in multiple environments. This helps ensure your project is compatible with across Python versions and environments.\u003C\u002Fsub>\n\n\u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Feb2a0b4778c633911303f3c00f87874f398b5180\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Fline-gradient.svg\" alt=\"line break\" width=\"100%\" height=\"3px\">\n\n## Configuration\n\nCustomize your README generation with a variety of options and style settings supported such as:\n\n| Option               | Description                                   | Default         |\n|----------------------|-----------------------------------------------|-----------------|\n| `--align`            | Text alignment in header                      | `center`        |\n| `--api`              | LLM API service provider                      | `offline`       |\n| `--badge-color`      | Badge color name or hex code                  | `0080ff`        |\n| `--badge-style`      | Badge icon style type                         | `flat`          |\n| `--header-style`     | Header template style                         | `classic`       |\n| `--navigation-style` | Table of contents style                       | `bullet`        |\n| `--emojis`           | Emoji theme packs prefixed to section titles  | `None`          |\n| `--logo`             | Project logo image                            | `blue`          |\n| `--logo-size`        | Logo image size                               | `30%`           |\n| `--model`            | Specific LLM model to use                     | `gpt-3.5-turbo` |\n| `--output`           | Output filename                               | `readme-ai.md`  |\n| `--repository`       | Repository URL or local directory path        | `None`          |\n| `--temperature`      | Creativity level for content generation       | `0.1`           |\n| `--tree-max-depth`   | Maximum depth of the directory tree structure | `2`             |\n\nRun the following command to view all available options:\n\n```sh\n❯ readmeai --help\n```\n\n\u003Csub>\n\nVisit the [Official Documentation][docs] for a complete guide on configuring and customizing README files.\n\n\u003C\u002Fsub>\n\n\u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Feb2a0b4778c633911303f3c00f87874f398b5180\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Fline-gradient.svg\" alt=\"line break\" width=\"100%\" height=\"3px\">\n\n## Example Gallery\n\nThis gallery showcases a diverse collection of README examples generated across various programming languages, frameworks, and project types.\n\n| Tech                | Repository              | README                 | Project Description        |\n|:--------------------|:------------------------|:-----------------------|:---------------------------|\n| Python              | [README-Python.md]      | [readmeai]             | ReadmeAI's core project    |\n| Apache Flink        | [README-Flink.md]       | [pyflink-poc]          | PyFlink proof of concept   |\n| Streamlit           | [README-Streamlit.md]   | [readmeai-streamlit]   | Web application interface  |\n| Vercel & NPM        | [README-Vercel.md]      | [github-readme-quotes] | Deployment showcase        |\n| Go & Docker         | [README-DockerGo.md]    | [docker-gs-ping]       | Containerized Golang app   |\n| FastAPI & Redis     | [README-FastAPI.md]     | [async-ml-inference]   | ML inference service       |\n| Java                | [README-Java.md]        | [minimal-todo]         | Minimalist To-Do app       |\n| PostgreSQL & DuckDB | [README-PostgreSQL.md]  | [buenavista]           | Database proxy server      |\n| Kotlin              | [README-Kotlin.md]      | [android-client]       | Mobile client application  |\n| Offline Mode        | [README-Offline.md] | [litellm]              | Offline functionality demo |\n\n### Community Contribution\n\n#### Share Your README Files\n\nWe invite developers to share their generated README files in our [Show & Tell][show-and-tell] discussion category. Your contributions help:\n\n- Showcase diverse documentation styles\n- Provide real-world examples\n- Help improve the ReadmeAI tool\n\nFind additional README examples in our [examples directory][examples-directory] on GitHub.\n\n\u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Feb2a0b4778c633911303f3c00f87874f398b5180\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Fline-gradient.svg\" alt=\"line break\" width=\"100%\" height=\"3px\">\n\n## Roadmap\n\n* [ ] Release `readmeai 1.0.0` with robust documentation creation and maintenance capabilities.\n* [ ] Extend template support for various `project types` and `programming languages`.\n* [ ] Develop `Vscode Extension` to generate README files directly in the editor.\n* [ ] Develop `GitHub Actions` to automate documentation updates.\n* [ ] Add `badge packs` to provide additional badge styles and options.\n  + [ ] Code coverage, CI\u002FCD status, project version, and more.\n\n## Contributing\n\nContributions are welcome! Please read the [Contributing Guide][contributing] to get started.\n\n- **💡 [Contributing Guide][contributing]**: Learn about our contribution process and coding standards.\n- **🐛 [Report an Issue][github-issues]**: Found a bug? Let us know!\n- **💬 [Start a Discussion][github-discussions]**: Have ideas or suggestions? We'd love to hear from you.\n\n\u003Cbr>\n\n\u003Cp align=\"left\">\n  \u003Ca href=\"https:\u002F\u002Fgithub.com{\u002Feli64s\u002Freadme-ai\u002F}graphs\u002Fcontributors\">\n    \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_336c3d029943.png\">\n  \u003C\u002Fa>\n\u003C\u002Fp>\n\n## Acknowledgments\n\nA big shoutout to the projects below for their awesome work and open-source contributions:\n\n\u003Cdiv style=\"display: flex; align-items: left;\">\n  \u003Ca href=\"https:\u002F\u002Fshields.io\u002F\">\n    \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_e62acc5edf1a.png\" alt=\"shields.io\" style=\"width: 50px; margin-right: 10px;\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fsimpleicons.org\u002F\">\n    \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_bb8bd3706318.png\" alt=\"simpleicons.org\" style=\"width: 50px; margin-right: 10px;\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Ftandpfun\u002Fskill-icons\">\n    \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_61dc78b2dd2e.png\" alt=\"tandpfun\u002Fskill-icons\" style=\"width: 50px; margin-right: 10px;\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Fastrit\u002Fcss.gg\">\n    \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_0b857fe2265e.png\" alt=\"astrit\u002Fcss.gg\" style=\"width: 50px; margin-right: 10px;\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002FIleriayo\u002Fmarkdown-badges\">\n    \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_11a5691c5b46.png\" alt=\"Ileriayo\u002Fmarkdown-badges\" style=\"width: 50px; margin-right: 10px;\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002FIleriayo\u002Fmarkdown-badges\">\n    \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_c78b4635e9b6.png\" alt=\"Ileriayo\u002Fmarkdown-badges\" style=\"width: 50px; margin-right: 10px;\">\n  \u003C\u002Fa>\n\u003C\u002Fdiv>\n\n## 🎗 License\n\nCopyright © 2023-2025 [readme-ai][readme-ai]. \u003Cbr \u002F>\nReleased under the [MIT][license] license.\n\n\u003Cdiv align=\"left\">\n\n[![][to-the-top]](#top)\n\n\u003C\u002Fdiv>\n\n\u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Feb2a0b4778c633911303f3c00f87874f398b5180\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Fline-gradient.svg\" alt=\"line break\" width=\"100%\" height=\"3px\">\n\n\u003C!-- REFERENCE LINKS -->\n\u003C!-- README-AI RESOURCES -->\n[readme-ai]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\n[readme-ai-streamlit]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai-streamlit\n[actions]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Factions\n[codecov]: https:\u002F\u002Fapp.codecov.io\u002Fgh\u002Feli64s\u002Freadme-ai\n[docs]: https:\u002F\u002Feli64s.github.io\u002Freadme-ai\n[github-discussions]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fdiscussions\n[github-issues]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fissues\n[github-pulls]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fpulls\n[mit]: https:\u002F\u002Fopensource.org\u002Flicense\u002Fmit\n[pepy]: https:\u002F\u002Fwww.pepy.tech\u002Fprojects\u002Freadmeai\n[contributing]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002FCONTRIBUTING.md\n[license]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002FLICENSE\n[to-the-top]: https:\u002F\u002Fimg.shields.io\u002Fbadge\u002FReturn-5D4ED3?style=flat&logo=ReadMe&logoColor=white\n\n\u003C!-- README-AI DEMOS -->\n[cli-demo]: https:\u002F\u002Fgithub.com\u002Fuser-attachments\u002Fassets\u002Fe1198922-5233-4a44-a5a8-15fa1cc4e2d7\n[streamlit-demo]: https:\u002F\u002Fgithub.com\u002Fuser-attachments\u002Fassets\u002Fc3f60665-4768-4baa-8e31-6b6e8c4c9248\n\n\u003C!-- THIRD-PARTY RESOURCES -->\n[docker-shield]: https:\u002F\u002Fimg.shields.io\u002Fbadge\u002FDocker-2496ED.svg?style=flat&logo=Docker&logoColor=white\n[docker-link]: https:\u002F\u002Fhub.docker.com\u002Fr\u002Fzeroxeli\u002Freadme-ai\n[python-link]: https:\u002F\u002Fwww.python.org\u002F\n[pip-link]: https:\u002F\u002Fpip.pypa.io\u002Fen\u002Fstable\u002F\n[pypi-shield]: https:\u002F\u002Fimg.shields.io\u002Fbadge\u002FPyPI-3775A9.svg?style=flat&logo=PyPI&logoColor=white\n[pypi-link]: https:\u002F\u002Fpypi.org\u002Fproject\u002Freadmeai\u002F\n[pipx-shield]: https:\u002F\u002Fimg.shields.io\u002Fbadge\u002Fpipx-2CFFAA.svg?style=flat&logo=pipx&logoColor=black\n[pipx-link]: https:\u002F\u002Fpipx.pypa.io\u002Fstable\u002F\n[uv-link]: https:\u002F\u002Fdocs.astral.sh\u002Fuv\u002F\n[pytest-shield]: https:\u002F\u002Fimg.shields.io\u002Fbadge\u002FPytest-0A9EDC.svg?style=flat&logo=Pytest&logoColor=white\n[pytest-link]: https:\u002F\u002Fdocs.pytest.org\u002Fen\u002F7.1.x\u002Fcontents.html\n[nox-link]: https:\u002F\u002Fnox.thea.codes\u002Fen\u002Fstable\u002F\n[streamlit-link]: https:\u002F\u002Freadme-ai.streamlit.app\u002F\n\n\u003C!-- BADGES & ICONS -->\n[shieldsio]: https:\u002F\u002Fshields.io\u002F\n[simple-icons]: https:\u002F\u002Fsimpleicons.org\u002F\n[skill-icons]: https:\u002F\u002Fgithub.com\u002Ftandpfun\u002Fskill-icons\n[github-profile-badges]: https:\u002F\u002Fgithub.com\u002FAveek-Saha\u002FGitHub-Profile-Badges\n[markdown-badges]: https:\u002F\u002Fgithub.com\u002FIleriayo\u002Fmarkdown-badges\n[css-icons]: https:\u002F\u002Fgithub.com\u002Fastrit\u002Fcss.gg\n\n\u003C!-- SIMPLE ICONS -->\n[python-svg]: https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fpython.svg\n[pipx-svg]: https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fpipx.svg\n[uv-svg]: https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fastral.svg\n[docker-svg]: https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fdocker.svg\n[git-svg]: https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fgit.svg\n[bash-svg]: https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fgnubash.svg\n[poetry-svg]: https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fpoetry.svg\n[streamlit-svg]: https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fstreamlit.svg\n\n\u003C!-- GIT HOST PROVIDERS -->\n[file-system]: https:\u002F\u002Fen.wikipedia.org\u002Fwiki\u002FFile_system\n[github]: https:\u002F\u002Fgithub.com\u002F\n[gitlab]: https:\u002F\u002Fgitlab.com\u002F\n[bitbucket]: https:\u002F\u002Fbitbucket.org\u002F\n\n\u003C!-- LLM API PROVIDERS -->\n[anthropic]: https:\u002F\u002Fdocs.anthropic.com\u002Fen\u002Fhome\n[gemini]: https:\u002F\u002Fai.google.dev\u002Ftutorials\u002Fpython_quickstart\n[ollama]: https:\u002F\u002Fgithub.com\u002Follama\u002Follama\n[openai]: https:\u002F\u002Fplatform.openai.com\u002Fdocs\u002Fquickstart\u002Faccount-setup:\n\n\u003C!-- EXAMPLES -->\n\u003C!-- FEATURES -->\n[project-overview]: https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_47d4913bd495.png\n[features-table]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Ffeatures\u002Ffeatures.png?raw=true\n[project-structure]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Fproject-structure\u002Fproject-structure.png?raw=true\n[project-index]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Fproject-structure\u002Fproject-index.png?raw=true\n[installation-steps]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Fgetting-started\u002Finstallation-steps.png?raw=true\n[usage-guides]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Fgetting-started\u002Fusage-guides.png?raw=true\n[community-and-support]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Fcommunity\u002Fcommunity-and-support.png?raw=true\n[contributing-guidelines]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Fcommunity\u002Fcontributing-guidelines.png?raw=true\n[readmeai.parsers]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Ftree\u002Fmain\u002Freadmeai\u002Fparsers\n[tree.py]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Freadmeai\u002Fgenerators\u002Ftree.py\n[prompts.toml]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Freadmeai\u002Fconfig\u002Fsettings\u002Fprompts.toml\n\n\u003C!-- EXAMPLES: INPUT REPOSITORY LINKS -->\n[readmeai]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\n[pyflink-poc]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Fpyflink-poc\n[readmeai-streamlit]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai-streamlit\n[github-readme-quotes]: https:\u002F\u002Fgithub.com\u002FPiyushSuthar\u002Fgithub-readme-quotes\n[docker-gs-ping]: https:\u002F\u002Fgithub.com\u002Folliefr\u002Fdocker-gs-ping\n[async-ml-inference]: https:\u002F\u002Fgithub.com\u002FFerrariDG\u002Fasync-ml-inference\n[minimal-todo]: https:\u002F\u002Fgithub.com\u002Favjinder\u002FMinimal-Todo\n[buenavista]: https:\u002F\u002Fgithub.com\u002Fjwills\u002Fbuenavista\n[android-client]: https:\u002F\u002Fgithub.com\u002Frumaan\u002Ffile.io-Android-Client\n[litellm]: https:\u002F\u002Fgithub.com\u002FBerriAI\u002Flitellm\n\n\u003C!-- EXAMPLES: OUTPUT README FILE LINKS -->\n[README-Python.md]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fexamples\u002Freadme-ai.md\n[README-Flink.md]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fexamples\u002Fheaders\u002Fmodern.md\n[README-Streamlit.md]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fexamples\u002Fbanners\u002Fsvg-banner.md\n[README-Vercel.md]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fexamples\u002Flogos\u002Fdalle.md\n[README-DockerGo.md]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fexamples\u002Freadme-docker-go.md\n[README-FastAPI.md]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fexamples\u002Freadme-fastapi-redis.md\n[README-Java.md]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fexamples\u002Fheaders\u002Fcompact.md\n[README-PostgreSQL.md]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fexamples\u002Fheaders\u002Fclassic.md\n[README-Kotlin.md]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fexamples\u002Freadme-kotlin.md\n[README-Offline.md]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fexamples\u002Foffline-mode\u002Freadme-litellm.md\n\n\u003C!-- EXAMPLES: OTHER RESOURCES -->\n[examples-directory]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Ftree\u002Fmain\u002Fexamples\n[show-and-tell]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fdiscussions\u002Fcategories\u002Fshow-and-tell\n","\u003Cdiv id=\"top\">\n\n\u003Cp align=\"center\">\n\n\u003Cdiv align=\"center\">\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\">\n    \u003Cimg\n      src=\"https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Flogo.svg\" \n      alt=\"ReadmeAI Logo\" width=\"60%\">\n  \u003C\u002Fa>\n\u003C\u002Fdiv>\n\n\u003C!-- \u003Cpicture>\n  \u003Csource media=\"(prefers-color-scheme: dark)\" srcset=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Flogo-gradient.svg\">\n  \u003Csource media=\"(prefers-color-scheme: light)\" srcset=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Flogo-gradient.svg\">\n  \u003Cimg alt=\"ReadmeAI Logo\" src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Flogo-gradient.svg\" width=\"60%\">\n\u003C\u002Fpicture> -->\n\n\u003C\u002Fp>\n\n\u003Cp align=\"center\">\n  \u003Cem>专为简洁、可定制性和开发者效率而设计。\u003C\u002Fem>\n\u003C\u002Fp>\n\n\u003Cp align=\"center\">\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Factions\">\n    \u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Factions\u002Fworkflow\u002Fstatus\u002Feli64s\u002Freadme-ai\u002Frelease-pipeline.yml?logo=githubactions&label=CI&logoColor=white&color=4169E1\" alt=\"Github Actions\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fapp.codecov.io\u002Fgh\u002Feli64s\u002Freadme-ai\">\n    \u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fcodecov\u002Fc\u002Fgithub\u002Feli64s\u002Freadme-ai?logo=codecov&logoColor=white&label=Coverage&color=5D4ED3\" alt=\"Test Coverage\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fpypi.python.org\u002Fpypi\u002Freadmeai\u002F\">\n    \u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fpypi\u002Fv\u002Freadmeai?logo=Python&logoColor=white&label=PyPI&color=7934C5\" alt=\"PyPI Version\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fwww.pepy.tech\u002Fprojects\u002Freadmeai\">\n    \u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fpepy\u002Fdt\u002Freadmeai?logo=PyPI&logoColor=white&label=Downloads&color=9400D3\" alt=\"Total Downloads\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fopensource.org\u002Flicense\u002Fmit\u002F\">\n    \u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Flicense\u002Feli64s\u002Freadme-ai?logo=opensourceinitiative&logoColor=white&label=License&color=8A2BE2\" alt=\"MIT License\">\n  \u003C\u002Fa>\n\u003C\u002Fp>\n\n\u003C\u002Fdiv>\n\n\u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Feb2a0b4778c633911303f3c00f87874f398b5180\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Fline-gradient.svg\" alt=\"分隔线\" width=\"100%\" height=\"3px\">\n\n## 快速链接\n\n- [简介](#introduction)\n- [演示](#demo)\n- [功能](#features)\n- [快速入门](#getting-started)\n- [配置](#configuration)\n- [示例图库](#example-gallery)\n- [贡献指南](#contributing)\n\n> [!重要提示]\n> 请查阅[官方文档][docs]，以获取完整的功能列表、自定义选项和示例。\n\n\u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Feb2a0b4778c633911303f3c00f87874f398b5180\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Fline-gradient.svg\" alt=\"分隔线\" width=\"100%\" height=\"3px\">\n\n## 简介\n\nReadmeAI 是一款开发者工具，它利用强大的仓库处理引擎和先进的语言模型，自动生成功能完善的 README 文件。你只需提供代码库的 URL 或路径，即可生成结构清晰、内容详尽的 README 文档。\n\n**为什么使用 ReadmeAI？**\n\n本项目旨在简化所有技术领域和不同经验水平下的文档编写与维护流程。其核心原则包括：\n\n- **🔵 自动化：** 通过一条命令即可生成详细且结构化的 README 文件。\n- **⚫️ 可定制：** 提供多种模板、样式、徽章等选项供选择。\n- **🟣 灵活：** 随时可在 `OpenAI`、`Ollama`、`Anthropic` 和 `Gemini` 之间切换。\n- **🟠 语言无关：** 兼容多种编程语言和框架。\n- **🟡 最佳实践：** 确保所有项目的文档整洁一致。\n- **🟢 智能过滤：** 基于可自定义的 `.readmeaiignore` 规则进行智能文件分析。\n- **⛔️ 离线模式：** 即使不使用 LLM API 服务，也能离线创建 README 文件。\n\n## 演示\n\n**在终端中运行：**\n\n[readmeai-cli-demo][cli-demo]\n\n\u003C!--\n**在浏览器中运行：**\n\n[readmeai-streamlit-demo][streamlit-demo]\n-->\n\n\u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Feb2a0b4778c633911303f3c00f87874f398b5180\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Fline-gradient.svg\" alt=\"分隔线\" width=\"100%\" height=\"3px\">\n\n## 功能\n\n### 自定义你的 README\n\n让我们从探索 ReadmeAI 支持的各种自定义选项和样式开始：\n\n\u003Cdiv align=\"left\">\n  \u003Ch6>头部样式\u003C\u002Fh6>\n  \u003Ctable>\n    \u003C!-- 头部样式：经典 -->\n    \u003Ctr>\n      \u003Ctd align=\"left\">\n        \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_4ae438975d6b.png\"\n             alt=\"经典头部\"\n             width=\"800\"\n             style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px;\">\n        \u003Cp align=\"left\">\u003Cb>CLI 命令：\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\n          \u003Ccode>$ readmeai --repository https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai-streamlit \\\n           --logo custom \\\n           --badge-color FF4B4B \\\n           --badge-style flat-square \\\n           --header-style classic\n          \u003C\u002Fcode>\n        \u003C\u002Fpre>\n      \u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003C!-- 头部样式：现代 -->\n    \u003Ctr>\n      \u003Ctd align=\"left\">\n        \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_b8f2c4657166.png\"\n             alt=\"现代头部\"\n             width=\"800\"\n             style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px;\">\n        \u003Cp align=\"left\">\u003Cb>CLI 命令：\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\n          \u003Ccode>$ readmeai --repository https:\u002F\u002Fgithub.com\u002Folliefr\u002Fdocker-gs-ping \\\n           --badge-color 00ADD8 \\\n           --badge-style for-the-badge \\\n           --header-style modern \\\n           --navigation-style roman\n          \u003C\u002Fcode>\n        \u003C\u002Fpre>\n      \u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003C!-- 头部样式：紧凑 -->\n    \u003Ctr>\n      \u003Ctd align=\"left\">\n        \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_e13f887a075a.png\"\n          alt=\"紧凑头部\"\n          width=\"800\"\n          style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px;\">\n        \u003Cp align=\"left\">\u003Cb>CLI 命令：\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\n          \u003Ccode>$ readmeai --repository https:\u002F\u002Fgithub.com\u002Frumaan\u002Ffile.io-Android-Client \\\n           --badge-style plastic \\\n           --badge-color blueviolet \\\n           --logo PURPLE \\\n           --header-style COMPACT \\\n           --navigation-style NUMBER \\\n           --emojis solar\n          \u003C\u002Fcode>\n        \u003C\u002Fpre>\n      \u003C\u002Ftd>\n    \u003C\u002Ftr>\n  \u003C\u002Ftable>\n\n\u003C!-- 页眉样式：横幅 -->\n  \u003Ch3>横幅样式\u003C\u002Fh3>\n  \u003Ctable>\n    \u003Ctr>\n      \u003Ctd align=\"left\">\n        \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_f52f25a10eb0.png\"\n          alt=\"控制台页眉\"\n          width=\"800\"\n          style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px;\">\n        \u003Cp align=\"left\">\u003Cb>CLI 命令：\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\n          \u003Ccode>$ readmeai --repository https:\u002F\u002Fgithub.com\u002Femcf\u002Fthepipe \\\n           --badge-style flat-square \\\n           --badge-color 8a2be2 \\\n           --header-style console \\\n           --navigation-style accordion \\\n           --emojis water\n          \u003C\u002Fcode>\n        \u003C\u002Fpre>\n      \u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003C!-- 页眉样式：SVG 横幅 -->\n    \u003Ctr>\n      \u003Ctd align=\"left\">\n        \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_435859b6bc89.png\"\n          alt=\"SVG 横幅\"\n          width=\"800\"\n          style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px;\">\n        \u003Cp align=\"left\">\u003Cb>CLI 命令：\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\n          \u003Ccode>$ readmeai --repository https:\u002F\u002Fgithub.com\u002FFerrariDG\u002Fasync-ml-inference \\\n           --badge-style plastic \\\n           --badge-color 43a047 \\\n           --header-style BANNER\n          \u003C\u002Fcode>\n        \u003C\u002Fpre>\n      \u003C\u002Ftd>\n    \u003C\u002Ftr>\n  \u003C\u002Ftable>\n\n  \u003C!-- 其他样式 -->\n  \u003Ch3>还有更多！\u003C\u002Fh3>\n  \u003Ctable>\n    \u003Ctr>\n      \u003Ctd align=\"left\" style=\"padding: 20px;\">\n        \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_47d4913bd495.png\"\n            alt=\"项目概览\"\n            width=\"800\"\n            style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px; margin-bottom: 15px;\">\n        \u003Cp align=\"left\" style=\"margin: 10px 0;\">\u003Cb>CLI 命令：\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\n          \u003Ccode>$ readmeai --repository 'https:\u002F\u002Fgithub.com\u002Feli64sreadme-ai-streamlit' \\\n           --badge-style FLAT-SQUARE \\\n           --badge-color E92063 \\\n           --header-style COMPACT \\\n           --navigation-style ACCORDION \\\n           --emojis RAINBOW \\\n           --logo ICE\n          \u003C\u002Fcode>\n        \u003C\u002Fpre>\n      \u003C\u002Ftd>\n    \u003C\u002Ftr>\n    \u003C!-- -->\n    \u003Ctr>\n      \u003Ctd align=\"left\" style=\"padding: 20px;\">\n        \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_84893724fe37.png\"\n            alt=\"自定义 Logo\"\n            width=\"800\"\n            style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px; margin-bottom: 15px;\">\n        \u003Cp align=\"left\" style=\"margin: 10px 0;\">\u003Cb>CLI 命令：\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\n          \u003Ccode>$ readmeai --repository https:\u002F\u002Fgithub.com\u002Fjwills\u002Fbuenavista \\\n           --align LEFT \\\n           --badge-style FLAT-SQUARE \\\n           --logo CUSTOM\n          \u003C\u002Fcode>\n        \u003C\u002Fpre>\n      \u003C\u002Ftd>\n    \u003C\u002Ftr>\n  \u003C\u002Ftable>\n\n  \u003C!-- -->\n  \u003C!-- \u003Ctable>\n    \u003Ctr>\n      \u003Ctd align=\"left\" width=\"50%\" style=\"padding: 20px;\">\n        \u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Fheaders\u002Fcustom-balloon.png\"\n            alt=\"气球 Logo\"\n            width=\"100%\"\n            style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px; margin-bottom: 15px;\">\n        \u003Cp align=\"left\" style=\"margin: 10px 0;\">\u003Cb>CLI 命令：\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\u003Ccode>$ readmeai --repository https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai-streamlit \\\n           --badge-style flat \\\n           --logo custom\u003C\u002Fcode>\u003C\u002Fpre>\n        \u003Cpre align=\"left\" style=\"margin-top: 10px;\">\u003Ccode>提供图片文件路径或 URL：\\\n           https:\u002F\u002Fwww.svgrepo.com\u002Fshow\u002F395851\u002Fballoon.svg\u003C\u002Fcode>\u003C\u002Fpre>\n      \u003C\u002Ftd>\n      \u003Ctd align=\"left\" width=\"50%\" style=\"padding: 20px;\">\n        \u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Fheaders\u002Fskill-icons-light.png\"\n            alt=\"技能图标\"\n            width=\"100%\"\n            style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px; margin-bottom: 15px;\">\n        \u003Cp align=\"left\" style=\"margin: 10px 0;\">\u003Cb>CLI 命令：\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\u003Ccode>$ readmeai --repository https:\u002F\u002Fgithub.com\u002FFerrariDG\u002Fasync-ml-inference \\\n           --badge-style skills-light \\\n           --logo grey\u003C\u002Fcode>\u003C\u002Fpre>\n      \u003C\u002Ftd>\n    \u003C\u002Ftr>\n  \u003C\u002Ftable>\n\n  \u003Ctable>\n    \u003Ctr>\n      \u003Ctd align=\"left\" width=\"50%\" style=\"padding: 20px;\">\n        \u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Fheaders\u002Fcompact.png\"\n            alt=\"紧凑型页眉\"\n            width=\"100%\"\n            style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px; margin-bottom: 15px;\">\n        \u003Cp align=\"left\" style=\"margin: 10px 0;\">\u003Cb>CLI 命令：\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\u003Ccode>$ readmeai --repository https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai \\\n           --logo cloud \\\n           --header-style compact \\\n           --navigation-style fold\u003C\u002Fcode>\u003C\u002Fpre>\n      \u003C\u002Ftd>\n      \u003Ctd align=\"left\" width=\"50%\" style=\"padding: 20px;\">\n        \u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Frefs\u002Fheads\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Fheaders\u002Fmodern-flat-square.png\"\n            alt=\"现代风格\"\n            width=\"100%\"\n            style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px; margin-bottom: 15px;\">\n        \u003Cp align=\"left\" style=\"margin: 10px 0;\">\u003Cb>CLI 命令：\u003C\u002Fb>\u003C\u002Fp>\n        \u003Cpre align=\"left\">\u003Ccode>$ readmeai --repository https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai \\\n           -i custom \\\n           -bc BA0098 \\\n           -bs flat-square \\\n           -hs modern \\\n           -ns fold\u003C\u002Fcode>\u003C\u002Fpre>\n      \u003C\u002Ftd>\n    \u003C\u002Ftr>\n  \u003C\u002Ftable> -->\n\u003C\u002Fdiv>\n\n### 生成的章节与内容\n\n\u003Cdetails>\u003Csummary>\u003Cstrong>꩜ 展开以查看更多！\u003C\u002Fstrong>\u003C\u002Fsummary>\u003Cbr>\n\n| \u003Ch3>项目简介\u003C\u002Fh3> \u003Cul>\u003Cli>本节捕捉了您项目的精髓和价值主张。\u003C\u002Fli>\u003Cli>用于生成此部分的提示模板可在此处查看[prompts.toml]。\u003C\u002Fli>\u003C\u002Ful> |\n| :--- |\n| ![][project-overview] |\n\n| \u003Ch3>功能表\u003C\u002Fh3> \u003Cul>\u003Cli>详细的功能分解和技术能力。\u003C\u002Fli>\u003Cli>用于生成此部分的提示模板可在此处查看[prompts.toml]。\u003C\u002Fli>\u003C\u002Ful> |\n| :--- |\n| ![][features-table] |\n\n| \u003Ch3>项目结构\u003C\u002Fh3> \u003Cul>\u003Cli>您项目的目录结构的可视化表示。\u003C\u002Fli>\u003Cli>该树状图使用[纯Python][tree.py]生成，并嵌入代码块中。\u003C\u002Fli>\u003C\u002Ful> |\n| :--- |\n| ![][project-structure] |\n| \u003Ch3>项目索引\u003C\u002Fh3> \u003Cul>\u003Cli>总结了项目的关键模块，这些模块也被用作下游[prompts.toml][prompts.toml]的上下文。\u003C\u002Fli>\u003C\u002Ful> |\n| ![][project-index] |\n\n| \u003Ch3>入门指南\u003C\u002Fh3> \u003Cul>\u003Cli>依赖项和系统要求在预处理过程中从代码库中提取出来。\u003C\u002Fli>\u003Cli>[解析器][readmeai.parsers]在这里承担了大部分繁重的工作。\u003C\u002Fli>\u003C\u002Ful> |\n| :--- |\n| ![][installation-steps] |\n| \u003Ch3>安装、使用与测试\u003C\u002Fh3> \u003Cul>\u003Cli>根据从代码库中提取的数据，自动生成设置说明和使用指南。\u003C\u002Fli>\u003C\u002Ful> |\n| ![][usage-guides] |\n\n| \u003Ch3>社区与支持\u003C\u002Fh3> \u003Cul>\u003Cli>开发路线图、贡献指南、许可证信息以及社区资源。\u003C\u002Fli>\u003Cli>还包含一个\u003Cem>返回按钮\u003C\u002Fem>,方便导航。\u003C\u002Fli>\u003C\u002Ful> |\n| :--- |\n| ![][community-and-support] |\n| \u003Ch3>贡献指南\u003C\u002Fh3> \u003Cul>\u003Cli>关于如何为项目做出贡献的说明，包括资源链接和基本的贡献指南。\u003C\u002Fli>\u003Cli>对于开源项目，还包含了贡献者图。\u003C\u002Fli>\u003C\u002Ful> |\n| ![][contributing-guidelines] |\n\n\u003C\u002Fdetails>\n\n\u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Feb2a0b4778c633911303f3c00f87874f398b5180\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Fline-gradient.svg\" alt=\"分隔线\" width=\"100%\" height=\"3px\">\n\n## 开始使用\n\n### 先决条件\n\nReadmeAI 需要 Python 3.9 或更高版本，以及以下任一种安装方法：\n\n| 要求                          | 详情                          |\n|--------------------------------------|----------------------------------|\n| • [Python][python-link] ≥3.9         | 核心运行时                     |\n| **安装方法**（选择其一）             |                                  |\n| • [pip][pip-link]                    | 默认的 Python 包管理工具       |\n| • [pipx][pipx-link]                  | 隔离环境安装工具               |\n| • [uv][uv-link]                      | 高性能包管理工具               |\n| • [docker][docker-link]              | 容器化环境                   |\n\n### 支持的仓库平台\n\n要生成 README 文件，请提供源仓库。ReadmeAI 支持以下平台：\n\n| 平台                   | 详情                   |\n|----------------------------|---------------------------|\n| [文件系统][file-system] | 本地仓库访问           |\n| [GitHub][github]           | 行业标准托管平台       |\n| [GitLab][gitlab]           | 全面 DevOps 集成       |\n| [Bitbucket][bitbucket]     | Atlassian 生态系统     |\n\n### 支持的 LLM API 服务\n\nReadmeAI 不依赖于特定模型，支持以下 LLM API 服务：\n\n| 提供商                          | 最适合场景        | 详情                  |\n|-----------------------------------|-----------------|--------------------------|\n| [OpenAI][openai]                  | 通用用途     | 行业领先的语言模型  |\n| [Anthropic][anthropic]            | 高级任务  | Claude 系列语言模型   |\n| [Google Gemini][gemini]           | 多模态 AI   | Google 最新技术      |\n| [Ollama][ollama]                  | 开源          | 无需 API 密钥        |\n| [离线模式][README-Offline.md]     | 本地运行    | 无需互联网连接       |\n\n---\n\n### 安装\n\nReadmeAI 已在 [PyPI][pypi-link] 上发布，名称为 readmeai，可通过以下方式安装：\n\n\u003C!-- #### 使用 `pip` [![pypi][pypi-shield]][pypi-link] -->\n\u003C!-- #### ![pip][python-svg]{ width=\"2%\" } Pip -->\n#### \u003Cimg width=\"2%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fpython.svg\"> Pip\n\n推荐大多数用户使用 pip 进行安装：\n\n```sh\n❯ pip install -U readmeai\n```\n\n\u003C!-- #### 使用 `pipx` [![pipx][pipx-shield]][pipx-link] -->\n\u003C!-- #### ![pipx][pipx-svg]{ width=\"2%\" } Pipx -->\n#### \u003Cimg width=\"2%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fpipx.svg\"> Pipx\n\n使用 pipx，readmeai 将被安装在一个隔离的环境中：\n\n```sh\n❯ pipx install readmeai\n```\n\n\u003C!-- #### ![uv][uv-svg]{ width=\"2%\" } Uv -->\n#### \u003Cimg width=\"2%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fuv.svg\"> Uv\n\n使用 [uv][uv-link] 是安装 readmeai 的最快方式：\n\n```sh\n❯ uv tool install readmeai\n```\n\n\u003C!-- #### 使用 `docker` [![docker][docker-shield]][docker-link] -->\n\u003C!-- #### ![docker][docker-svg]{ width=\"2%\" } Docker -->\n#### \u003Cimg width=\"2%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fdocker.svg\"> Docker\n\n要在容器化环境中运行 `readmeai`，请从 [Docker Hub][dockerhub-link] 拉取最新镜像：\n\n```sh\n❯ docker pull zeroxeli\u002Freadme-ai:latest\n```\n\n\u003C!-- #### ![build-from-source][git-svg]{ width=\"2%\" } 从源码构建 -->\n#### \u003Cimg width=\"2%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fgit.svg\"> 从源码构建\n\n\u003Cdetails>\u003Csummary>\u003Ci>点击以从源码构建 \u003Ccode>readmeai\u003C\u002Fcode>\u003C\u002Fi>\u003C\u002Fsummary>\n\n1. **克隆仓库：**\n\n    ```sh\n    ❯ git clone https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\n    ```\n\n2. **进入项目目录：**\n\n    ```sh\n    ❯ cd readme-ai\n    ```\n\n3. **安装依赖：**\n\n    ```sh\n    ❯ pip install -r setup\u002Frequirements.txt\n    ```\n\n或者，使用 [设置脚本][setup-script] 来安装依赖：\n\n\u003C!-- #### ![bash][bash-svg]{ width=\"2%\" } Bash -->\n##### \u003Cimg width=\"1.5%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fgnubash.svg\"> Bash\n\n1. **运行设置脚本：**\n\n    ```sh\n    ❯ bash setup\u002Fsetup.sh\n    ```\n\n或者，使用 `poetry` 来构建并安装项目依赖：\n\n\u003C!-- #### ![poetry][poetry-svg]{ width=\"2%\" } Poetry -->\n##### \u003Cimg width=\"1.5%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fpoetry.svg\"> Poetry\n\n1. **使用 poetry 安装依赖：**\n\n    ```sh\n    ❯ poetry install\n    ```\n\n\u003C\u002Fdetails>\n\u003Cbr>\n\n### 其他可选依赖项\n\n> [!重要]\n> 要使用 **Anthropic** 和 **Google Gemini** 客户端，需要额外的依赖项。请通过以下 extras 安装包：\n>\n> - **Anthropic：**\n>   ```sh\n>   ❯ pip install \"readmeai[anthropic]\"\n>   ```\n> - **Google Gemini：**\n>   ```sh\n>   ❯ pip install \"readmeai[google-generativeai]\"\n>   ```\n>\n> - **安装多个客户端：**\n>   ```sh\n>   ❯ pip install \"readmeai[anthropic,google-generativeai]\"\n>   ```\n\n### 使用方法\n\n#### 设置您的 API 密钥\n\n在使用第三方服务运行 `readmeai` 时，您必须提供有效的 API 密钥。例如，`OpenAI` 客户端的设置如下：\n\n```sh\n❯ export OPENAI_API_KEY=\u003Cyour_api_key>\n\n# 对于 Windows 用户：\n❯ set OPENAI_API_KEY=\u003Cyour_api_key>\n```\n\n\u003Cdetails closed>\u003Csummary>点击查看用于 \u003Ccode>Ollama\u003C\u002Fcode>、\u003Ccode>Anthropic\u003C\u002Fcode>、\u003Ccode>Google Gemini\u003C\u002Fcode> 的环境变量\u003C\u002Fsummary>\n\u003Cbr>\n\u003Cdetails closed>\u003Csummary>Ollama\u003C\u002Fsummary>\n\u003Cbr>\n\n有关 Ollama 服务器设置的更多信息，请参阅 [Ollama 文档][ollama]。\n\n开始之前，请按照以下步骤操作：\n\n1. 从 Ollama 仓库拉取您选择的模型：\n\n\t```sh\n\t❯ ollama pull llama3.2:latest\n\t```\n\n2. 启动 Ollama 服务器并设置 `OLLAMA_HOST` 环境变量：\n\n\t```sh\n\t❯ export OLLAMA_HOST=127.0.0.1 && ollama serve\n\t```\n\n\u003C\u002Fdetails>\n\u003Cdetails closed>\u003Csummary>Anthropic\u003C\u002Fsummary>\n\n1. 导出您的 Anthropic API 密钥：\n\n\t```sh\n\t❯ export ANTHROPIC_API_KEY=\u003Cyour_api_key>\n\t```\n\n\u003C\u002Fdetails>\n\u003Cdetails closed>\u003Csummary>Google Gemini\u003C\u002Fsummary>\n\n1. 导出您的 Google Gemini API 密钥：\n\n\t```sh\n\t❯ export GOOGLE_API_KEY=\u003Cyour_api_key\n\t```\n\n\u003C\u002Fdetails>\n\u003C\u002Fdetails>\n\n#### 使用 CLI\n\n##### 使用 LLM API 服务运行\n\n以下是使用 `OpenAI` 客户端运行 `readmeai` 所需的最小命令：\n\n```sh\n❯ readmeai --api openai -o readmeai-openai.md -r https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\n```\n\n> [!重要]\n> 默认模型设置为 `gpt-3.5-turbo`，在成本和性能之间提供了最佳平衡。当使用 `gpt-4` 系列及更高版本的模型时，请注意监控您的费用和使用情况，以避免产生意外费用。\n\nReadmeAI 可以轻松切换 API 提供商和模型。我们可以使用与上述相同的命令，但采用 `Anthropic` 客户端：\n```sh\n❯ readmeai --api anthropic -m claude-3-5-sonnet-20240620 -o readmeai-anthropic.md -r https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\n```\n\n最后，使用 `Google Gemini` 客户端：\n\n```sh\n❯ readmeai --api gemini -m gemini-1.5-flash -o readmeai-gemini.md -r https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\n```\n\n##### 使用本地模型运行\n\n我们还可以使用 Ollama 中免费且开源的本地托管模型来运行 `readmeai`：\n\n```sh\n❯ readmeai --api ollama --model llama3.2 -r https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\n```\n\n##### 在本地代码库上运行\n\n要从本地代码库生成 README 文件，只需提供项目的完整路径：\n\n```sh\n❯ readmeai --repository \u002Fusers\u002Fusername\u002Fprojects\u002Fmyproject --api openai\n```\n\n添加更多自定义选项：\n\n```sh\n❯ readmeai --repository https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai \\\n           --output readmeai.md \\\n           --api openai \\\n           --model gpt-4 \\\n           --badge-color A931EC \\\n           --badge-style flat-square \\\n           --header-style compact \\\n           --navigation-style fold \\\n           --temperature 0.9 \\\n           --tree-depth 2\n           --logo LLM \\\n           --emojis solar\n```\n\n##### 在离线模式下运行\n\nReadmeAI 支持“离线模式”，允许您在不使用 LLM API 服务的情况下生成 README 文件。\n\n```sh\n❯ readmeai --api offline -o readmeai-offline.md -r https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\n```\n\n\u003C!-- #### ![docker][docker-svg]{ width=\"2%\" } Docker -->\n#### \u003Cimg width=\"2%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fdocker.svg\"> Docker\n\n在 Docker 容器中运行 `readmeai` CLI：\n\n```sh\n❯ docker run -it --rm \\\n    -e OPENAI_API_KEY=$OPENAI_API_KEY \\\n    -v \"$(pwd)\":\u002Fapp zeroxeli\u002Freadme-ai:latest \\\n    --repository https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai \\\n    --api openai\n```\n\n\u003C!-- #### ![streamlit][streamlit-svg]{ width=\"2%\" } Streamlit -->\n#### \u003Cimg width=\"2%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fstreamlit.svg\"> Streamlit\n\n无需安装，即可在 Streamlit Cloud 上直接在浏览器中试用 readme-ai。\n\n[\u003Cimg align=\"center\" src=\"https:\u002F\u002Fstatic.streamlit.io\u002Fbadges\u002Fstreamlit_badge_black_white.svg\" width=\"20%\">](https:\u002F\u002Freadme-ai.streamlit.app\u002F)\n\n有关该应用程序的更多详细信息，请参阅 GitHub 上的 [readme-ai-streamlit][readme-ai-streamlit] 仓库。\n\n> [!警告]\n> readme-ai Streamlit Web 应用程序可能并不总是与最新功能保持同步。请使用命令行界面 (CLI) 以获得最新的功能。\n\n\u003C!-- #### ![build-from-source][git-svg]{ width=\"2%\" } 从源码构建 -->\n#### \u003Cimg width=\"2%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fgit.svg\"> 从源码构建\n\n\u003Cdetails>\u003Csummary>\u003Ci>点击以从源码运行 \u003Ccode>readmeai\u003C\u002Fcode>\u003C\u002Fi>\u003C\u002Fsummary>\n\n\u003C!-- #### ![bash][bash-svg]{ width=\"2%\" } Bash -->\n##### \u003Cimg width=\"1.5%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fgnubash.svg\"> Bash\n\n如果您使用 bash 脚本从源码安装了该项目，请运行以下命令：\n\n1. 激活虚拟环境：\n\n   ```sh\n   ❯ conda activate readmeai\n   ```\n\n2. 运行 CLI：\n\n   ```sh\n   ❯ python3 -m readmeai.cli.main -r https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\n\t```\n\n\u003C!-- #### ![poetry][poetry-svg]{ width=\"2%\" } Poetry -->\n##### \u003Cimg width=\"1.5%\" src=\"https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fpoetry.svg\"> Poetry\n\n1. 激活虚拟环境：\n\n   ```sh\n   ❯ poetry shell\n   ```\n\n2. 运行 CLI：\n\n   ```sh\n   ❯ poetry run python3 -m readmeai.cli.main -r https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\n   ```\n\n\u003C\u002Fdetails>\n\n\u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Feb2a0b4778c633911303f3c00f87874f398b5180\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Fline-gradient.svg\" alt=\"分隔线\" width=\"100%\" height=\"3px\">\n\n### 测试\n\n\u003C!-- #### 使用 `pytest` [![pytest][pytest-shield]][pytest-link] -->\n\n开发和测试过程中使用了 [pytest][pytest-link] 和 [nox][nox-link] 框架。\n\n使用 uv 安装依赖项：\n\n```sh\n❯ uv pip install --dev --group test --all-extras\n```\n\n使用 Pytest 运行单元测试套件：\n\n```sh\n❯ make test\n```\n\n使用 nox，在 Python 版本 `3.9`、`3.10`、`3.11` 和 `3.12` 上测试应用程序：\n\n```sh\n❯ make test-nox\n```\n\n> [!提示]\n> \u003Csub>Nox 是一种用于在多个环境中测试应用程序的自动化工具。这有助于确保您的项目在不同 Python 版本和环境中都具有兼容性。\u003C\u002Fsub>\n\n\u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Feb2a0b4778c633911303f3c00f87874f398b5180\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Fline-gradient.svg\" alt=\"分隔线\" width=\"100%\" height=\"3px\">\n\n## 配置\n\n通过多种选项和样式设置来自定义您的 README 生成，例如：\n\n| 选项               | 描述                                   | 默认         |\n|----------------------|-----------------------------------------------|-----------------|\n| `--align`            | 标题中的文本对齐方式                      | `center`        |\n| `--api`              | LLM API 服务提供商                      | `offline`       |\n| `--badge-color`      | 徽章颜色名称或十六进制代码                  | `0080ff`        |\n| `--badge-style`      | 徽章图标样式类型                         | `flat`          |\n| `--header-style`     | 标题模板样式                             | `classic`       |\n| `--navigation-style` | 目录样式                                 | `bullet`        |\n| `--emojis`           | 在章节标题前添加的表情主题包             | `None`          |\n| `--logo`             | 项目徽标图片                            | `blue`          |\n| `--logo-size`        | 徽标图片大小                               | `30%`           |\n| `--model`            | 要使用的特定 LLM 模型                     | `gpt-3.5-turbo` |\n| `--output`           | 输出文件名                               | `readme-ai.md`  |\n| `--repository`       | 仓库 URL 或本地目录路径                   | `None`          |\n| `--temperature`      | 内容生成的创造力水平                     | `0.1`           |\n| `--tree-max-depth`   | 目录树结构的最大深度                     | `2`             |\n\n运行以下命令以查看所有可用选项：\n\n```sh\n❯ readmeai --help\n```\n\n\u003Csub>\n\n访问[官方文档][docs]以获取关于配置和自定义 README 文件的完整指南。\n\n\u003C\u002Fsub>\n\n\u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Feb2a0b4778c633911303f3c00f87874f398b5180\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Fline-gradient.svg\" alt=\"分隔线\" width=\"100%\" height=\"3px\">\n\n## 示例图库\n\n本图库展示了跨多种编程语言、框架和项目类型的多样化 README 示例。\n\n| 技术                | 仓库              | README                 | 项目描述        |\n|:--------------------|:------------------------|:-----------------------|:---------------------------|\n| Python              | [README-Python.md]      | [readmeai]             | ReadmeAI 的核心项目    |\n| Apache Flink        | [README-Flink.md]       | [pyflink-poc]          | PyFlink 概念验证       |\n| Streamlit           | [README-Streamlit.md]   | [readmeai-streamlit]   | Web 应用程序界面  |\n| Vercel & NPM        | [README-Vercel.md]      | [github-readme-quotes] | 部署展示        |\n| Go & Docker         | [README-DockerGo.md]    | [docker-gs-ping]       | 容器化 Golang 应用   |\n| FastAPI & Redis     | [README-FastAPI.md]     | [async-ml-inference]   | 机器学习推理服务       |\n| Java                | [README-Java.md]        | [minimal-todo]         | 极简待办事项应用       |\n| PostgreSQL & DuckDB | [README-PostgreSQL.md]  | [buenavista]           | 数据库代理服务器      |\n| Kotlin              | [README-Kotlin.md]      | [android-client]       | 移动客户端应用程序  |\n| 离线模式        | [README-Offline.md] | [litellm]              | 离线功能演示       |\n\n### 社区贡献\n\n#### 分享您的 README 文件\n\n我们诚邀开发者在我们的[Show & Tell][show-and-tell]讨论版块中分享他们生成的 README 文件。您的贡献有助于：\n\n- 展示多样化的文档风格\n- 提供真实世界的示例\n- 帮助改进 ReadmeAI 工具\n\n您还可以在 GitHub 上的[示例目录][examples-directory]中找到更多 README 示例。\n\n\u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Feb2a0b4778c633911303f3c00f87874f398b5180\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Fline-gradient.svg\" alt=\"分隔线\" width=\"100%\" height=\"3px\">\n\n## 路线图\n\n* [ ] 发布 `readmeai 1.0.0`，具备强大的文档创建和维护能力。\n* [ ] 扩展模板支持，覆盖更多 `项目类型` 和 `编程语言`。\n* [ ] 开发 `Vscode 扩展`，以便直接在编辑器中生成 README 文件。\n* [ ] 开发 `GitHub Actions`，实现文档更新的自动化。\n* [ ] 添加 `徽章包`，提供更多徽章样式和选项。\n  + [ ] 代码覆盖率、CI\u002FCD 状态、项目版本等。\n\n## 贡献\n\n欢迎贡献！请阅读[贡献指南][contributing]开始您的旅程。\n\n- **💡 [贡献指南][contributing]**：了解我们的贡献流程和编码规范。\n- **🐛 [报告问题][github-issues]**：发现错误？请告诉我们！\n- **💬 [发起讨论][github-discussions]**：有想法或建议吗？我们非常期待您的反馈。\n\n\u003Cbr>\n\n\u003Cp align=\"left\">\n  \u003Ca href=\"https:\u002F\u002Fgithub.com{\u002Feli64s\u002Freadme-ai\u002F}graphs\u002Fcontributors\">\n    \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_336c3d029943.png\">\n  \u003C\u002Fa>\n\u003C\u002Fp>\n\n## 致谢\n\n特别感谢以下项目及其出色的开源贡献：\n\n\u003Cdiv style=\"display: flex; align-items: left;\">\n  \u003Ca href=\"https:\u002F\u002Fshields.io\u002F\">\n    \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_e62acc5edf1a.png\" alt=\"shields.io\" style=\"width: 50px; margin-right: 10px;\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fsimpleicons.org\u002F\">\n    \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_bb8bd3706318.png\" alt=\"simpleicons.org\" style=\"width: 50px; margin-right: 10px;\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Ftandpfun\u002Fskill-icons\">\n    \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_61dc78b2dd2e.png\" alt=\"tandpfun\u002Fskill-icons\" style=\"width: 50px; margin-right: 10px;\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Fastrit\u002Fcss.gg\">\n    \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_0b857fe2265e.png\" alt=\"astrit\u002Fcss.gg\" style=\"width: 50px; margin-right: 10px;\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002FIleriayo\u002Fmarkdown-badges\">\n    \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_11a5691c5b46.png\" alt=\"Ileriayo\u002Fmarkdown-badges\" style=\"width: 50px; margin-right: 10px;\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002FIleriayo\u002Fmarkdown-badges\">\n    \u003Cimg src=\"https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_c78b4635e9b6.png\" alt=\"Ileriayo\u002Fmarkdown-badges\" style=\"width: 50px; margin-right: 10px;\">\n  \u003C\u002Fa>\n\u003C\u002Fdiv>\n\n## 🎗 许可证\n\n版权所有 © 2023-2025 [readme-ai][readme-ai]。\u003Cbr \u002F>\n根据 [MIT][license] 许可证发布。\n\n\u003Cdiv align=\"left\">\n\n[![][to-the-top]](#top)\n\n\u003C\u002Fdiv>\n\n\u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Feli64s\u002Freadme-ai\u002Feb2a0b4778c633911303f3c00f87874f398b5180\u002Fdocs\u002Fdocs\u002Fassets\u002Fsvg\u002Fline-gradient.svg\" alt=\"分隔线\" width=\"100%\" height=\"3px\">\n\n\u003C!-- 参考链接 -->\n\u003C!-- README-AI 资源 -->\n[readme-ai]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\n[readme-ai-streamlit]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai-streamlit\n[actions]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Factions\n[codecov]: https:\u002F\u002Fapp.codecov.io\u002Fgh\u002Feli64s\u002Freadme-ai\n[docs]: https:\u002F\u002Feli64s.github.io\u002Freadme-ai\n[github-discussions]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fdiscussions\n[github-issues]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fissues\n[github-pulls]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fpulls\n[mit]: https:\u002F\u002Fopensource.org\u002Flicense\u002Fmit\n[pepy]: https:\u002F\u002Fwww.pepy.tech\u002Fprojects\u002Freadmeai\n[contributing]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002FCONTRIBUTING.md\n[license]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002FLICENSE\n[to-the-top]: https:\u002F\u002Fimg.shields.io\u002Fbadge\u002FReturn-5D4ED3?style=flat&logo=ReadMe&logoColor=white\n\n\u003C!-- README-AI 演示 -->\n[cli-demo]: https:\u002F\u002Fgithub.com\u002Fuser-attachments\u002Fassets\u002Fe1198922-5233-4a44-a5a8-15fa1cc4e2d7\n[streamlit-demo]: https:\u002F\u002Fgithub.com\u002Fuser-attachments\u002Fassets\u002Fc3f60665-4768-4baa-8e31-6b6e8c4c9248\n\n\u003C!-- 第三方资源 -->\n[docker-shield]: https:\u002F\u002Fimg.shields.io\u002Fbadge\u002FDocker-2496ED.svg?style=flat&logo=Docker&logoColor=white\n[docker-link]: https:\u002F\u002Fhub.docker.com\u002Fr\u002Fzeroxeli\u002Freadme-ai\n[python-link]: https:\u002F\u002Fwww.python.org\u002F\n[pip-link]: https:\u002F\u002Fpip.pypa.io\u002Fen\u002Fstable\u002F\n[pypi-shield]: https:\u002F\u002Fimg.shields.io\u002Fbadge\u002FPyPI-3775A9.svg?style=flat&logo=PyPI&logoColor=white\n[pypi-link]: https:\u002F\u002Fpypi.org\u002Fproject\u002Freadmeai\u002F\n[pipx-shield]: https:\u002F\u002Fimg.shields.io\u002Fbadge\u002Fpipx-2CFFAA.svg?style=flat&logo=pipx&logoColor=black\n[pipx-link]: https:\u002F\u002Fpipx.pypa.io\u002Fstable\u002F\n[uv-link]: https:\u002F\u002Fdocs.astral.sh\u002Fuv\u002F\n[pytest-shield]: https:\u002F\u002Fimg.shields.io\u002Fbadge\u002FPytest-0A9EDC.svg?style=flat&logo=Pytest&logoColor=white\n[pytest-link]: https:\u002F\u002Fdocs.pytest.org\u002Fen\u002F7.1.x\u002Fcontents.html\n[nox-link]: https:\u002F\u002Fnox.thea.codes\u002Fen\u002Fstable\u002F\n[streamlit-link]: https:\u002F\u002Freadme-ai.streamlit.app\u002F\n\n\u003C!-- 徽章与图标 -->\n[shieldsio]: https:\u002F\u002Fshields.io\u002F\n[simple-icons]: https:\u002F\u002Fsimpleicons.org\u002F\n[skill-icons]: https:\u002F\u002Fgithub.com\u002Ftandpfun\u002Fskill-icons\n[github-profile-badges]: https:\u002F\u002Fgithub.com\u002FAveek-Saha\u002FGitHub-Profile-Badges\n[markdown-badges]: https:\u002F\u002Fgithub.com\u002FIleriayo\u002Fmarkdown-badges\n[css-icons]: https:\u002F\u002Fgithub.com\u002Fastrit\u002Fcss.gg\n\n\u003C!-- 简单图标 -->\n[python-svg]: https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fpython.svg\n[pipx-svg]: https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fpipx.svg\n[uv-svg]: https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fastral.svg\n[docker-svg]: https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fdocker.svg\n[git-svg]: https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fgit.svg\n[bash-svg]: https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fgnubash.svg\n[poetry-svg]: https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fpoetry.svg\n[streamlit-svg]: https:\u002F\u002Fsimpleicons.org\u002Ficons\u002Fstreamlit.svg\n\n\u003C!-- 版本控制托管平台 -->\n[file-system]: https:\u002F\u002Fen.wikipedia.org\u002Fwiki\u002FFile_system\n[github]: https:\u002F\u002Fgithub.com\u002F\n[gitlab]: https:\u002F\u002Fgitlab.com\u002F\n[bitbucket]: https:\u002F\u002Fbitbucket.org\u002F\n\n\u003C!-- 大语言模型 API 提供商 -->\n[anthropic]: https:\u002F\u002Fdocs.anthropic.com\u002Fen\u002Fhome\n[gemini]: https:\u002F\u002Fai.google.dev\u002Ftutorials\u002Fpython_quickstart\n[ollama]: https:\u002F\u002Fgithub.com\u002Follama\u002Follama\n[openai]: https:\u002F\u002Fplatform.openai.com\u002Fdocs\u002Fquickstart\u002Faccount-setup:\n\n\u003C!-- 示例 -->\n\u003C!-- 功能 -->\n[project-overview]: https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_readme_47d4913bd495.png\n[features-table]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Ffeatures\u002Ffeatures.png?raw=true\n[project-structure]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Fproject-structure\u002Fproject-structure.png?raw=true\n[project-index]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Fproject-structure\u002Fproject-index.png?raw=true\n[installation-steps]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Fgetting-started\u002Finstallation-steps.png?raw=true\n[usage-guides]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Fgetting-started\u002Fusage-guides.png?raw=true\n[community-and-support]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Fcommunity\u002Fcommunity-and-support.png?raw=true\n[contributing-guidelines]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fdocs\u002Fdocs\u002Fassets\u002Fimg\u002Fcommunity\u002Fcontributing-guidelines.png?raw=true\n[readmeai.parsers]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Ftree\u002Fmain\u002Freadmeai\u002Fparsers\n[tree.py]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Freadmeai\u002Fgenerators\u002Ftree.py\n[prompts.toml]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Freadmeai\u002Fconfig\u002Fsettings\u002Fprompts.toml\n\n\u003C!-- 示例：输入仓库链接 -->\n[readmeai]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\n[pyflink-poc]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Fpyflink-poc\n[readmeai-streamlit]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai-streamlit\n[github-readme-quotes]: https:\u002F\u002Fgithub.com\u002FPiyushSuthar\u002Fgithub-readme-quotes\n[docker-gs-ping]: https:\u002F\u002Fgithub.com\u002Folliefr\u002Fdocker-gs-ping\n[async-ml-inference]: https:\u002F\u002Fgithub.com\u002FFerrariDG\u002Fasync-ml-inference\n[minimal-todo]: https:\u002F\u002Fgithub.com\u002Favjinder\u002FMinimal-Todo\n[buenavista]: https:\u002F\u002Fgithub.com\u002Fjwills\u002Fbuenavista\n[android-client]: https:\u002F\u002Fgithub.com\u002Frumaan\u002Ffile.io-Android-Client\n[litellm]: https:\u002F\u002Fgithub.com\u002FBerriAI\u002Flitellm\n\n\u003C!-- 示例：输出 README 文件链接 -->\n[README-Python.md]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fexamples\u002Freadme-ai.md\n[README-Flink.md]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fexamples\u002Fheaders\u002Fmodern.md\n[README-Streamlit.md]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fexamples\u002Fbanners\u002Fsvg-banner.md\n[README-Vercel.md]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fexamples\u002Flogos\u002Fdalle.md\n[README-DockerGo.md]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fexamples\u002Freadme-docker-go.md\n[README-FastAPI.md]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fexamples\u002Freadme-fastapi-redis.md\n[README-Java.md]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fexamples\u002Fheaders\u002Fcompact.md\n[README-PostgreSQL.md]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fexamples\u002Fheaders\u002Fclassic.md\n[README-Kotlin.md]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fexamples\u002Freadme-kotlin.md\n[README-Offline.md]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fexamples\u002Foffline-mode\u002Freadme-litellm.md\n\n\u003C!-- 示例：其他资源 -->\n[examples-directory]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Ftree\u002Fmain\u002Fexamples\n[show-and-tell]: https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fdiscussions\u002Fcategories\u002Fshow-and-tell","# readme-ai 快速上手指南\n\n`readme-ai` 是一款强大的开发者工具，能够利用大语言模型（LLM）自动分析代码仓库并生成结构清晰、内容详实的 README 文档。支持多种模型后端（OpenAI, Ollama, Anthropic, Gemini）及丰富的样式定制。\n\n## 环境准备\n\n在开始之前，请确保您的开发环境满足以下要求：\n\n*   **操作系统**：Linux, macOS 或 Windows (WSL 推荐)。\n*   **Python 版本**：Python 3.9 或更高版本。\n*   **依赖项**：\n    *   `pip` (Python 包管理工具)\n    *   **Git** (用于克隆仓库或处理本地路径)\n    *   **LLM API Key** (可选)：若使用云端模型需准备 OpenAI\u002FAnthropic\u002FGemini 的 API Key；若使用本地模型需安装并运行 [Ollama](https:\u002F\u002Follama.com\u002F)。\n\n> **提示**：国内用户若访问 PyPI 较慢，建议在安装命令中指定清华或阿里镜像源。\n\n## 安装步骤\n\n推荐使用 `pip` 进行安装。\n\n### 1. 基础安装\n```bash\npip install readmeai\n```\n\n### 2. 国内加速安装（推荐）\n如果您在中国大陆，使用以下命令可显著提升下载速度：\n```bash\npip install readmeai -i https:\u002F\u002Fpypi.tuna.tsinghua.edu.cn\u002Fsimple\n```\n\n### 3. 验证安装\n安装完成后，检查版本号以确认安装成功：\n```bash\nreadmeai --version\n```\n\n## 基本使用\n\n### 1. 配置 API Key (可选)\n如果您计划使用云端大模型（如 GPT-4），请先导出 API Key。若使用本地 Ollama 或离线模式，可跳过此步。\n\n```bash\nexport OPENAI_API_KEY=\"your-api-key-here\"\n# 或者针对其他模型\nexport ANTHROPIC_API_KEY=\"your-api-key-here\"\n```\n\n### 2. 生成 README\n只需一条命令即可为远程仓库或本地项目生成 README。\n\n#### 场景 A：分析远程 GitHub 仓库\n```bash\nreadmeai --repository https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\n```\n\n#### 场景 B：分析本地代码目录\n```bash\nreadmeai --repository \u002Fpath\u002Fto\u002Fyour\u002Flocal\u002Fproject\n```\n\n#### 场景 C：自定义样式与模型（进阶示例）\n指定使用 `compact` 头部风格、彩色徽章以及特定的 Emoji 主题：\n```bash\nreadmeai --repository https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai \\\n  --header-style COMPACT \\\n  --badge-color FF4B4B \\\n  --badge-style flat-square \\\n  --emojis solar \\\n  --model openai\n```\n\n### 3. 查看结果\n命令执行完毕后，工具会在当前目录下生成一个名为 `README.md` 的文件。您可以直接在 GitHub 上推送该文件，或使用 Markdown 编辑器预览。\n\n> **注意**：生成的文件默认包含智能过滤逻辑，会自动忽略 `.git` 目录及配置文件。如需自定义忽略规则，可在项目根目录创建 `.readmeaiignore` 文件。","某初创团队的后端工程师刚完成一个微服务项目的重构，急需在周五前向开源社区发布代码，但面对杂乱的代码库和紧迫的工期，编写一份专业的 README 文档成了拦路虎。\n\n### 没有 readme-ai 时\n- **耗时费力**：工程师需要手动遍历数百个文件，人工梳理项目结构、依赖关系和核心功能，耗费整个下午仅完成大纲。\n- **风格不一**：团队成员轮流补全文档，导致格式混乱、语气不统一，缺乏专业的徽章（Badges）和清晰的章节划分。\n- **更新滞后**：代码迭代后，文档往往忘记同步更新，导致安装步骤与实际版本不符，引发用户投诉。\n- **多模型切换困难**：若想尝试不同大模型生成的文案风格，需手动复制代码到多个网页端工具，流程繁琐且存在代码泄露风险。\n\n### 使用 readme-ai 后\n- **一键生成**：只需在终端运行一条命令指向代码库，readme-ai 自动分析文件结构，几分钟内输出包含安装指南、API 说明和使用示例的完整文档。\n- **专业规范**：自动生成统一的 Markdown 风格，内置丰富的徽章支持和多种精美模板，确保文档看起来像成熟开源项目。\n- **实时同步**：每次代码重大更新后，重新运行 readme-ai 即可智能识别变更并刷新文档内容，始终保持“文档即代码”的一致性。\n- **灵活定制**：工程师可随意在命令行切换 OpenAI、Ollama 或 Gemini 等后端模型，甚至通过 `.readmeaiignore` 文件精准控制哪些文件参与分析，兼顾隐私与效果。\n\nreadme-ai 将原本需要数小时的文档编写工作压缩至分钟级，让开发者能专注于核心代码逻辑，同时确保开源项目拥有世界级的“门面”。","https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002Feli64s_readme-ai_4ae43897.png","eli64s","Eli Salamie","https:\u002F\u002Foss.gittoolsai.com\u002Favatars\u002Feli64s_1788e8df.jpg","AI ⌬ Art ⌬ Meta ⌬","Founder @InnerAura","United States",null,"elisalamie.com","https:\u002F\u002Fgithub.com\u002Feli64s",[85,89,93,97],{"name":86,"color":87,"percentage":88},"Python","#3572A5",96,{"name":90,"color":91,"percentage":92},"Shell","#89e051",2.9,{"name":94,"color":95,"percentage":96},"Makefile","#427819",1,{"name":98,"color":99,"percentage":100},"Dockerfile","#384d54",0.1,2890,281,"2026-04-04T03:43:11","MIT","未说明",{"notes":107,"python":105,"dependencies":108},"该工具是一个命令行工具，支持多种大语言模型后端（OpenAI, Ollama, Anthropic, Gemini），并具备离线模式（无需调用 LLM API）。具体运行环境依赖（如 Python 版本、具体库）在提供的片段中未列出，通常此类工具需要安装 Python 及通过 pip 安装 readmeai 包。",[105],[26,13,14,15,53],[111,112,113,114,115,116,117,118,119,120,121,122,123,124,125,126,127,128,129,130],"readme-generator","readme","readme-md-generator","ai","markdown","documentation","developer-tools","documentation-generator","python","markdown-generator","devtools","readme-template","badge-generator","ai-documentation","anthropic","cli","gemini","gpt","agents","ai-agents","2026-03-27T02:49:30.150509","2026-04-06T08:44:24.206158",[134,139,144,149,154,159],{"id":135,"question_zh":136,"answer_zh":137,"source_url":138},15502,"遇到 '429 Too Many Requests' 错误怎么办？","这通常是因为 API 请求过于频繁触发了速率限制。维护者已更新代码（model.py），现在会自动处理异常并重试。如果达到最大重试次数后仍然失败，生成的 README.md 文件中会包含具体的状态码和错误名称。请克隆最新版本的代码以获取此修复。","https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fissues\u002F20",{"id":140,"question_zh":141,"answer_zh":142,"source_url":143},15503,"为什么提供 API Key 后仍报错 '404 Not Found' 或提示未提供 API Key？","这通常是因为 OpenAI 的 ChatGPT 账户和 API 账户是分开的。即使你订阅了 ChatGPT Plus（GPT-4），也不代表自动拥有了 API 访问权限。你需要单独为 API 账户添加账单信息（Billing Info）。此外，确保在环境变量中正确设置了 `OPENAI_API_KEY`，或者在命令行中使用 `--api-key` 参数传入。","https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fissues\u002F77",{"id":145,"question_zh":146,"answer_zh":147,"source_url":148},15504,"遇到 '401 Unauthorized' 错误该如何解决？","该错误表示 API Key 无效或未通过认证。请检查以下几点：1. 确认 API Key 拼写正确且没有多余的空格；2. 确保你的 OpenAI 账户已绑定支付方式并处于活跃状态（免费试用额度用完或未绑定信用卡可能导致此问题）；3. 尝试升级 readme-ai 到最新版本 (`pip install --upgrade readmeai`)，因为旧版本可能存在认证头传递的 bug。","https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fissues\u002F63",{"id":150,"question_zh":151,"answer_zh":152,"source_url":153},15505,"如何使用 readme-ai 处理私有仓库或本地代码库？","工具支持通过本地路径处理代码库。你可以先将私有仓库克隆到本地，然后使用 `-r` 或 `--repository` 参数指向本地文件夹路径（例如 `~\u002Fprojects\u002Fmy-awesome-project`）。如果遇到 'Invalid repository URL or path' 错误，请确保已升级到最新版本 (`pip install --upgrade readmeai`)，因为早期版本对本地路径的支持存在缺陷。注意：目前主要支持本地路径方式处理私有仓库，直接传入 SSH 格式的 git 地址可能不被支持。","https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fissues\u002F43",{"id":155,"question_zh":156,"answer_zh":157,"source_url":158},15506,"生成的 README 内容空洞或任务执行失败（Task failed）是什么原因？","这通常是因为使用了免费版的 OpenAI 账户或模型配额不足，导致无法完整分析代码库。许多用户反馈在使用付费账户（Paid Account）后问题得以解决。请确保你的 API Key 关联的是已充值的付费账户，并且有足够的余额或配额来支持完整的代码分析任务。","https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fissues\u002F26",{"id":160,"question_zh":161,"answer_zh":162,"source_url":138},15507,"生成 README 需要多长时间？","生成时间取决于代码库的大小和复杂度。如果耗时过长，通常是因为触发了 API 的速率限制（429 错误）导致程序在反复重试。维护者已在最新版本中优化了异常处理和重试机制。如果网络正常且账户配额充足，一般几分钟内即可完成；若长时间无响应，请检查终端输出中的 HTTP 状态码错误。",[164,169,174,179,184,189,194,199,204,209,214,219,224,229,234,239],{"id":165,"version":166,"summary_zh":167,"released_at":168},90159,"v0.1.6","## ✨ 功能特性\n\n- 重构：降低 Markdown 表格生成方法的复杂度。@eli64s (#70)\n- 增强：为大语言模型提示词添加更多上下文。@eli64s (#69)\n- 新功能：添加 CLI 选项 --emojis，用于更改 README 标题前缀。@eli64s (#67)\n\n## 🪲 错误修复\n\n- 修复：#35 更新分词逻辑，该逻辑曾导致大型代码库出现问题。@eli64s (#68)\n- 修复 #65：更新针对 `build.gradle` 文件的依赖项解析方法。@eli64s (#66)\n\n## 📄 文档\n\n- 文档：更新 readmeai 演示视频。@eli64s (#71)\n\n## ⚙️ 依赖项更新\n\n- 将 urllib3 从 2.0.6 升级到 2.0.7 @dependabot (#64)\n\n---","2023-10-24T21:43:24",{"id":170,"version":171,"summary_zh":172,"released_at":173},90160,"v0.1.5","## 变更内容\n\n## 🚀 功能\n\n- feat: 添加对三种徽章图标样式的支持。@eli64s (#62)\n- feat: 添加德语版 README 文件 [README-de](https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Fdocs\u002FREADME-de.md)，并更新其他 README 文件（法语、简体中文）。\n\n## 🧩 依赖项更新\n\n- 将 urllib3 从 2.0.5 升级到 2.0.6 @dependabot (#60)\n","2023-10-16T00:29:31",{"id":175,"version":176,"summary_zh":177,"released_at":178},90161,"v0.1.4","## 变更内容\n\n## 🚀 功能\n\n- 添加新的 SVG 徽章图标，用户可以通过 CLI 选项 `--badges` 进行选择 @eli64s (#58)\n- 重构 `readmeai` 包的结构，以提升组织性和可读性 @eli64s (#58)","2023-10-01T01:38:29",{"id":180,"version":181,"summary_zh":182,"released_at":183},90162,"v0.1.3","## 变更内容\n\n## 🚀 功能\n\n- 安装脚本增强 @hansipie (#42)\n\n## 🧹 杂项\n\n- 将 CLI 解耦为独立目录，以提高可读性和可维护性 @eli64s (#57)\n\n## 📄 文档\n\n- 添加其他语言的 README 文件 [法语、简体中文] @eli64s (#55)\n","2023-09-30T07:42:12",{"id":185,"version":186,"summary_zh":187,"released_at":188},90163,"v0.1.2","## 变更内容\n\n##  🔐 安全性\n- 使用纯 Python 实现自定义树形结构生成方法。移除了对 `Tree` 命令依赖带来的开销，并降低了使用 `subprocess` 模块执行该命令所带来的风险 @eli64s (#53)\n\n## 🛠 维护\n- 重构代码库中的小细节，以提高可读性并修复各类小 bug @eli64s (#54)\n\n---\n","2023-09-26T03:00:31",{"id":190,"version":191,"summary_zh":192,"released_at":193},90164,"v0.1.1","## 变更内容\n\n### 🚀 功能\n\n- 添加 CLI 选项，以离线模式运行 *readme-ai*（不调用 LLM）@eli64s (#52)\n- 添加 CLI 选项，用于指定 LLM 引擎并调整温度 @eli64s (#50)\n\n### 🛠 维护\n\n- 移除预处理代码库元数据时的冗余 `git clone` 操作 @eli64s (#51)\n- 将 [conf.py](https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Freadmeai\u002Fconf.py) 中剩余的数据类重构为 Pydantic 模型\n\n---","2023-09-25T02:52:08",{"id":195,"version":196,"summary_zh":197,"released_at":198},90165,"v0.1.0","## [v0.1.0] - *2023-09-20*\n### ✨ 新特性\n\n- 将项目部署到 Streamlit Community Cloud，提供基于 Web 的 README 生成界面。\n   -  [🛸 前往 Streamlit 上的 readme-ai！](https:\u002F\u002Freadmeai.streamlit.app\u002F)\n\n### 🐛 修复的 bug\n\n- 更新配置文件 [ignore_files.toml](https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Freadmeai\u002Fconf\u002Fignore_files.toml)，停止忽略以下文件扩展名：\n   - yaml、toml、txt、lock\n\n### 🧹 杂项\n\n- 重新生成 [examples](https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Ftree\u002Fmain\u002Fexamples) 目录中的所有 README 文件，以反映工具的最新更改。\n\n---","2023-09-20T21:53:22",{"id":200,"version":201,"summary_zh":202,"released_at":203},90166,"v0.0.9","## [v0.0.9] - *2023-09-19*\n\n### 🧹 杂项\n\n- 更新 README 文件，以增强项目文档。\n  - 添加 [配置](https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002FREADME.md#-configuration) 部分，提供自定义工具的上下文信息。\n  - 简化 [快速入门](https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002FREADME.md#-getting-started) 部分中的安装和运行说明。\n  - 更新 [路线图](https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002FREADME.md#-roadmap) 部分，加入最新的项目目标。\n\n---","2023-09-19T05:09:26",{"id":205,"version":206,"summary_zh":207,"released_at":208},90167,"v0.0.8","## [v0.0.8] - *2023-09-18*\n\n### 🐛 问题修复\n\n- 更新了 [parse.py](https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Freadmeai\u002Fparse.py) 和 [preprocess.py](https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002Freadmeai\u002Fpreprocess.py) 中的文件解析逻辑，以支持包含以下依赖文件的代码库（问题 [#37](https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fissues\u002F37)）。\n  - *CMakeLists.txt*\n  - *Makefile.am*\n  - *configure.ac*\n- 感谢 [@mooujarrar](https:\u002F\u002Fgithub.com\u002Fmooujarrar) 在解决此问题时提供的帮助！\n### 🔐 安全性\n\n- 将 [gitpython](https:\u002F\u002Fgithub.com\u002Fgitpython-developers\u002FGitPython) 模块升级至 *3.1.36* 版本，以修复安全漏洞（Dependabot 警报 [#5](https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fsecurity\u002Fdependabot\u002F5) 和问题 [#43](https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fissues\u002F43)）。\n\n---","2023-09-18T22:29:24",{"id":210,"version":211,"summary_zh":212,"released_at":213},90168,"v0.0.7","## [v0.0.7] - *2023-08-30*\n\n⚠️ 本版本修复了在 Windows 系统上使用 *GitPython* 包克隆 Git 仓库时存在的安全漏洞。如果代码从包含恶意 `git.exe` 或 `git` 可执行文件的目录中运行，该漏洞可能导致任意命令执行。\n\n### 🔐 安全修复\n\n#### *任意命令执行防护*\n\n- Dependabot 警报 [#3](https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fsecurity\u002Fdependabot\u002F3)：Windows 系统上 GitPython 的不受信搜索路径问题，可能导致任意代码执行。\n- 之前的 Git 克隆实现会将 `env` 参数设置为当前工作目录中的 Git 可执行文件路径。这种做法存在安全风险，因为代码可能执行来自恶意仓库的任意 `git` 命令。\n    ```python\n    git.Repo.clone_from(repo_path, temp_dir, depth=1)\n    ```\n- 现已更新 `env` 参数，显式指定 Git 可执行文件的绝对路径。这样可以确保用于克隆仓库的 Git 可执行文件是系统路径中安装的那个，而不是位于当前工作目录中的文件。\n    ```python\n    git.Repo.clone_from(repo_path, temp_dir, depth=1, env=git_exec_path)\n    ```\n\n### 🚀 新功能与改进\n\n#### *代码模块化*\n\n- 引入三个方法，用于隔离 Git 可执行文件的查找与验证逻辑。\n  - `find_git_executable()`：确定 Git 可执行文件的绝对路径。\n  - `validate_git_executable()`：验证找到的 Git 可执行文件路径。\n  - `validate_file_permissions()`：验证克隆后仓库的文件权限。\n\n#### *文件权限检查*\n\n- 对于 Unix 系统，新增检查以确保克隆后的仓库权限被设置为 `0o700`。这是安全临时目录的最佳实践，可防止未经授权的用户访问该目录。\n\n⚠️ 这些更新旨在缓解 Dependabot 警报 [#3](https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fsecurity\u002Fdependabot\u002F3) 中提到的安全漏洞。建议用户将 *readme-ai* 更新至最新版本，即运行 `pip install --upgrade readmeai`。请务必注意此漏洞，并在从不可信源克隆仓库时保持谨慎，尤其是 Windows 用户。 \n\n---","2023-08-30T08:40:13",{"id":215,"version":216,"summary_zh":217,"released_at":218},90169,"v0.0.6","## [v0.0.6] - *2023-08-29*\r\n\r\n### 🐛 Bug Fixes\r\n\r\n- Corrected PyPI issue where the *readmeai* package was not being installed correctly.\r\n  - The [conf](.\u002Freadmeai\u002Fconf\u002F) directory was not being included in the PyPI distribution as it was located in the project's root directory.\r\n  - The tool now uses the [pkg_resources](https:\u002F\u002Fsetuptools.pypa.io\u002Fen\u002Flatest\u002Fpkg_resources.html#) module to access the *conf* directory from the *readmeai* package.\r\n\r\n---","2023-08-29T23:34:07",{"id":220,"version":221,"summary_zh":222,"released_at":223},90170,"v0.0.5","## [v0.0.5] - *2023-07-31*\r\n\r\n### ✨ Added\r\n\r\n- Add [.dockerignore](.\u002F.dockerignore) file to exclude unnecessary files from the Docker image.\r\n\r\n### 🛠️ Fixed\r\n\r\n- Missing html closing tags in README tables were causing the GitHub pages site to render incorrectly.\r\n  - Added closing tags to fix the issue.\r\n  - Additionally, restructured a few sections of the README.\r\n\r\n### 🛡️ Security\r\n\r\n- Refactor Dockerfile to adhere to best practices.\r\n  - *Package Installation and Cleanup:* Clean up cache after installing packages with apt-get to reduce the image size.\r\n  - *Non-root User Creation:* Introduce a non-root user within the container to limit permissions and enhance security.\r\n    - Assign a specific user ID and group ID that don't have superuser privileges.\r\n  - *File Permissions Management:* Explicitly manage file permissions to prevent potential security risks when the image operates in varied contexts.\r\n\r\n---","2023-08-01T03:20:17",{"id":225,"version":226,"summary_zh":227,"released_at":228},90171,"v0.0.4","## [v0.0.4] - *2023-07-30*\r\n\r\n### Added\r\n\r\n- 📦 Publish *readme-ai* CLI to PyPI under the module name [readmeai](https:\u002F\u002Fpypi.org\u002Fproject\u002Freadmeai\u002F).\r\n  - Refactored the codebase to use [Click](https:\u002F\u002Fclick.palletsprojects.com\u002Fen\u002F8.1.x\u002F), migrating from argparse.\r\n  - Update directory name from *src* to *readmeai* to match PyPI module name.\r\n  - Update [readmeai](.\u002Freadmeai\u002F) modules to use relative imports.\r\n  - Update metadata and dependency details in the [pyproject.toml](.\u002Fpyproject.toml) file.\r\n- 📖 Update [README.md](.\u002FREADME.md) documentation.\r\n  - Add *PyPI* package badges at the top of the README.\r\n  - Include instructions for downloading and running the *readme-ai* CLI from PyPI.\r\n- ⚙️ Add helper script [update_image.sh](.\u002Fscripts\u002Fupdate_image.sh) to push the latest image to Docker Hub.\r\n### Fixed\r\n\r\n- 🐳 Update Dockerfile commands\r\n  - Add line to install the *tree* command in order to generate the repository tree structure in the README.\r\n  - Update installtion to use the latest *readmeai* distribution from PyPI.\r\n\r\n### Removed\r\n\r\n- 🗑 Removed *setup.py* script from the project root directory.\r\n  - Poetry is used for package management via [pyproject.toml](.\u002Fpyproject.toml). Thus, *setup.py* is no longer needed.\r\n  \r\n---","2023-07-30T10:42:53",{"id":230,"version":231,"summary_zh":232,"released_at":233},90172,"v0.0.3","## [v0.0.3] - *2023-06-29*\r\n\r\n### Added\r\n\r\n- 🪄 Add [pydantic](https:\u002F\u002Fpydantic-docs.helpmanual.io\u002F) to validate the user's repository and api key inputs.\r\n  - Validation was moved from *main.py* to *conf.py*.\r\n- 📖 Update [README.md](https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai\u002Fblob\u002Fmain\u002FREADME.md) file contents.\r\n  - Add Changelog section\r\n  - Reformat HTML code blocks\r\n\r\n### Removed\r\n\r\n- 📦 Remove [dacite](https:\u002F\u002Fgithub.com\u002Fkonradhalas\u002Fdacite) dependency now that *pydantic* is used for dataclass creation.\r\n\r\n---\r\n","2023-06-29T13:22:15",{"id":235,"version":236,"summary_zh":237,"released_at":238},90173,"v0.0.2","## [v0.0.2] - *2023-06-28*\r\n\r\n### Added\r\n\r\n- 📃 Add [CHANGELOG.md](.\u002FCHANGELOG.md) to track changes to the project.\r\n- 📼 Add new directory [examples\u002Fvideo](.\u002Fexamples\u002Fvideo) to store mp4 videos to demonstrate the *readme-ai* tool.\r\n\r\n### Changed\r\n\r\n- 🖋 Update [Makefile](.\u002FMakefile) and [setup.sh](.\u002Fsetup\u002Fsetup.sh) to use *poetry* for dependency management.\r\n\r\n### Removed\r\n\r\n- 🔧 Remove [requirements.txt](.\u002Frequirements.txt) from the installation and setup scripts.\r\n- 📄 Remove outdated example README.md files from the [examples](.\u002Fexamples) directory.\r\n\r\n---\r\n","2023-06-29T02:18:00",{"id":240,"version":241,"summary_zh":242,"released_at":243},90174,"v0.0.1","# 🏷 First Release: *readme-ai v0.0.1*\r\n\r\nAfter a few months of development, the first release of *readme-ai* is  here! This command-line tool leverages the power of OpenAI's GPT language model APIs to automatically generate beautifully structured and informative README markdown documents.\r\n\r\nWith *readme-ai*, you can effortlessly create detailed and easy-to-understand READMEs, saving valuable time that can be devoted to your project's development.\r\n\r\n## 🔮 Features\r\n\r\nDiscover the unique features of *readme-ai* [here.](https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai#%EF%B8%8F-features)\r\n\r\n## 🕹 How to Use\r\n\r\nGet started quickly with our comprehensive guide [here.](https:\u002F\u002Fgithub.com\u002Feli64s\u002Freadme-ai#-getting-started)\r\n\r\n## 📍 Future Roadmap\r\n\r\nWe have an exciting vision for the future of *readme-ai* and are committed to continuous improvement based on your valuable feedback. We encourage users to contribute and participate in the ongoing development of the project. In the meantime, we hope that *readme-ai* becomes an everyday tool in your technical workflow!\r\n\r\nIf you're enjoying *readme-ai*, show your support by giving the project a star ⭐ and sharing it with your peers!","2023-06-28T13:19:55"]