{"id":30804866,"url":"https://github.com/aibox22/readmex","last_synced_at":"2026-04-01T18:26:09.891Z","repository":{"id":302445379,"uuid":"1012469602","full_name":"aibox22/readmeX","owner":"aibox22","description":"An AI Powered README and Interactive Wiki Generator for Any Projects. AI驱动的README及交互式Wiki生成工具，面向中文的开源DeepWiki。","archived":false,"fork":false,"pushed_at":"2025-07-09T15:14:54.000Z","size":2368,"stargazers_count":318,"open_issues_count":10,"forks_count":15,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-31T19:39:45.040Z","etag":null,"topics":["ai-tools","cli","documentation","gpt","llm","markdown","python","readme"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aibox22.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-02T11:34:31.000Z","updated_at":"2025-07-31T16:28:29.000Z","dependencies_parsed_at":"2025-07-05T16:18:02.280Z","dependency_job_id":null,"html_url":"https://github.com/aibox22/readmeX","commit_stats":null,"previous_names":["thu-ailab/ai-readme","aibox22/auto-readme","aibox22/readmex"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/aibox22/readmeX","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aibox22%2FreadmeX","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aibox22%2FreadmeX/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aibox22%2FreadmeX/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aibox22%2FreadmeX/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aibox22","download_url":"https://codeload.github.com/aibox22/readmeX/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aibox22%2FreadmeX/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273838345,"owners_count":25177163,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-05T02:00:09.113Z","response_time":402,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai-tools","cli","documentation","gpt","llm","markdown","python","readme"],"created_at":"2025-09-06T00:08:35.612Z","updated_at":"2025-10-09T14:17:06.259Z","avatar_url":"https://github.com/aibox22.png","language":"Python","readme":"\n\u003ca id=\"readme-top\"\u003e\u003c/a\u003e\n\n\u003c!-- LANGUAGE SWITCH --\u003e\n\u003cdiv align=\"center\"\u003e\n  \nEnglish | [简体中文](README_CN.md)\n\n\u003c/div\u003e\n\n\u003c!-- PROJECT POSTER --\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"images/poster.png\" alt=\"Poster\" width=\"50%\"\u003e\n\u003c/div\u003e\n\n---\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003c!-- \u003ca href=\"https://github.com/aibox22/readmex\"\u003e\n    \u003cimg src=\"images/logo.png\" alt=\"Logo\" height=\"100\"\u003e\n  \u003c/a\u003e --\u003e\n\n\u003ch3 align=\"center\"\u003ereadmex\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    🚀 AI-Powered README Generator: Automatically creates beautiful READMEs and interactive wikis for any repository! Can run all in local with your own models.\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/aibox22/readmex\"\u003e\u003cstrong\u003eExplore the docs »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n  \u003c/p\u003e\n\n  \u003c!-- PROJECT SHIELDS --\u003e\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n\u003c!-- [![Latest Release][release-shield]][release-url]\n![Release Date][release-date-shield] --\u003e\n[![License][license-shield]][license-url]\n\n  \u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/aibox22/readmex\"\u003eView Demo\u003c/a\u003e\n    \u0026middot;\n    \u003ca href=\"https://github.com/aibox22/readmex/issues/new?labels=bug\u0026template=bug-report---.md\"\u003eReport Bug\u003c/a\u003e\n    \u0026middot;\n    \u003ca href=\"https://github.com/aibox22/readmex/issues/new?labels=enhancement\u0026template=feature-request---.md\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#built-with\"\u003eBuilt With\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#acknowledgments\"\u003eAcknowledgments\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## 📖 About The Project\n\n[![Flow Chart](images/flow.png)](https://example.com)\n\nAI-Powered README Generator is an AI-powered tool that automatically generates comprehensive Markdown README files for your projects. It crafts well-structured documentation that includes project details, technology stack, setup instructions, usage examples, badges, logos, and more.\n\n### Key Features\n\n- 🤖 **AI-Powered READMEs**: Generate comprehensive Markdown READMEs instantly.\n- 🔗 **Auto Badges**: Creates and embeds relevant status badges (contributors, forks, stars, etc.).\n- 🖼️ **Smart Logo Design**: Crafts a unique project logo automatically.\n- 🧠 **Tech Stack Identification**: Automatically detects and includes the project's technology stack.\n- 🌐 **Context-Aware Intelligence**: Tailors content to your project's specific context and needs.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n### Built With\n\n- [![Python][Python]][Python-url]\n- [![OpenAI][OpenAI]][OpenAI-url]\n- [![Rich][Rich]][Rich-url]\n\n### Supported Programming Languages\n\n\u003cdetails\u003e\n\u003csummary\u003eClick to expand supported languages\u003c/summary\u003e\n\n#### Web Development\n- **JavaScript**\n- **TypeScript**\n- **HTML**\n- **CSS**\n- **SCSS**\n- **Sass**\n- **Less**\n- **Stylus**\n- **Pug**\n- **Handlebars**\n- **Mustache**\n- **Twig**\n- **Smarty**\n- **Jinja**\n- **Vue**\n\n#### Programming Languages\n- **Python**\n- **Java**\n- **C**\n- **C++**\n- **C#**\n- **Go**\n- **Rust**\n- **PHP**\n- **Ruby**\n- **Swift**\n- **Kotlin**\n- **Scala**\n- **R**\n- **MATLAB**\n- **Perl**\n- **Lua**\n- **Dart**\n- **F#**\n- **Visual Basic**\n- **Assembly**\n- **Objective-C**\n- **Haskell**\n- **Erlang**\n- **Elixir**\n- **Clojure**\n- **CoffeeScript**\n- **PowerShell**\n- **Shell**\n- **Batch**\n- **Solidity**\n\n#### Build \u0026 Configuration\n- **Dockerfile**\n- **Makefile**\n- **CMake**\n- **Gradle**\n- **Maven**\n- **Nix**\n- **Terraform**\n\n#### Data \u0026 Documentation\n- **Jupyter**\n- **Protobuf**\n- **GraphQL**\n- **WebAssembly**\n\n#### Editor \u0026 IDE\n- **Vim**\n- **Emacs**\n\n\u003c/details\u003e\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- GETTING STARTED --\u003e\n## 🚀 Getting Started\n\nThis is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple steps.\n\n### Prerequisites\n\n- Python 3.7+\n\n### Installation\n\n1. Install the package using pip:\n   ```bash\n   pip install readmex\n   ```\n### Configuration\n\n`readmex` requires API keys for both the Language Model (for generating text) and the Text-to-Image model (for generating logos). You can configure these in one of two ways. Environment variables take precedence.\n\n#### 1. Environment Variables (Recommended for CI/CD)\n\nSet the following environment variables in your shell:\n\n```bash\nexport LLM_API_KEY=\"your_llm_api_key\"       # Required\nexport T2I_API_KEY=\"your_t2i_api_key\"       # Required\n\n# Optional: Specify custom API endpoints and models\nexport LLM_BASE_URL=\"https://api.example.com/v1\"\nexport T2I_BASE_URL=\"https://api.example.com/v1\"\nexport LLM_MODEL_NAME=\"your-llm-model\"\nexport T2I_MODEL_NAME=\"your-t2i-model\"\n\n# Optional: Embedding model configuration for RAG (Retrieval-Augmented Generation)\nexport EMBEDDING_API_KEY=\"your_embedding_api_key\"     # Optional, for web embedding models\nexport EMBEDDING_BASE_URL=\"https://api.example.com/v1\" # Optional, for web embedding models\nexport EMBEDDING_MODEL_NAME=\"text-embedding-3-small\"   # Optional, embedding model name\nexport LOCAL_EMBEDDING=\"true\"                         # Optional, use local embedding model (default: true)\n\n# Optional: Performance configuration\nexport MAX_WORKERS=\"10\"                               # Optional, max concurrent threads (default: 10)\n```\n\n#### 2. Global Config File (Recommended for Local Use)\n\nFor convenience, you can create a global configuration file. The tool will automatically look for it.\n\n1.  Create the directory: `mkdir -p ~/.readmex`\n2.  Create the config file: `~/.readmex/config.json`\n3.  Add your credentials and any optional settings. You can also include personal information, which will be used as defaults during interactive prompts:\n\n```json\n{\n  \"LLM_API_KEY\": \"your_llm_api_key\",\n  \"T2I_API_KEY\": \"your_t2i_api_key\",\n  \"LLM_BASE_URL\": \"https://api.example.com/v1\",\n  \"T2I_BASE_URL\": \"https://api.example.com/v1\",\n  \"LLM_MODEL_NAME\": \"gpt-4\",\n  \"T2I_MODEL_NAME\": \"dall-e-3\",\n  \"EMBEDDING_API_KEY\": \"your_embedding_api_key\",\n  \"EMBEDDING_BASE_URL\": \"https://api.example.com/v1\",\n  \"EMBEDDING_MODEL_NAME\": \"text-embedding-3-small\",\n  \"LOCAL_EMBEDDING\": \"true\",\n  \"MAX_WORKERS\": \"10\",\n  \"github_username\": \"your_github_username\",\n  \"twitter_handle\": \"your_twitter_handle\",\n  \"linkedin_username\": \"your_linkedin_username\",\n  \"email\": \"your_email@example.com\"\n}\n```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- USAGE EXAMPLES --\u003e\n## 💻 Usage\n\nOnce installed, you can use the `readmex` package in the command line. To generate your README, run the following:\n\n### Method 1: Using the installed command (Recommended)\n```bash\nreadmex\n```\n\n### Method 2: Running as a Python module\n```bash\n# Run the package directly\npython -m readmex\n\n# Or run the CLI module specifically\npython -m readmex.utils.cli\n```\n\n### Method 3: Development mode (for contributors)\n```bash\n# From the project root directory\npython src/readmex/utils/cli.py\n```\n\n### Command Line Options\n\nAll methods support the same command line arguments:\n\n```bash\n# Interactive mode (default)\nreadmex\n\n# Generate for current directory\nreadmex .\n\n# Generate for specific directory\nreadmex /path/to/your/project\n\n# Generate MkDocs website\nreadmex --website\n\n# Generate website and serve locally\nreadmex --website --serve\n\n# Deploy to GitHub Pages\nreadmex --deploy\n\n# Enable debug mode (skip LLM calls for testing)\nreadmex --debug\n\n# Enable silent mode (auto-generate without prompts)\nreadmex --silent\n\n# Enable verbose mode (show detailed information)\nreadmex --verbose\n```\n\nThis will:\n1. generate a `project_structure.txt` file, which contains the project structure.\n2. generate a `script_description.json` file, which contains the description of the scripts in the project.\n3. generate a `requirements.txt` file, which contains the requirements of the project.\n4. generate a `logo.png` file, which contains the logo of the project.\n5. generate a `README.md` file, which contains the README of the project.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- ROADMAP --\u003e\n## 🗺️ Roadmap\n\n- [ ] Prompt Engineering for Logo Generation\n- [ ] Multi-language Support\n- [ ] Enhanced AI Descriptions for Project Features\n\nSee the [open issues](https://github.com/aibox22/readmex/issues) for a full list of proposed features (and known issues).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- CONTRIBUTING --\u003e\n## 🤝 Contributing\n\nContributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### Top contributors:\n\n\u003ca href=\"https://github.com/aibox22/readmex/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=aibox22/readmex\" alt=\"contrib.rocks image\" /\u003e\n\u003c/a\u003e\n\n\n\n\u003c!-- LICENSE --\u003e\n## 🎗 License\n\nCopyright © 2024-2025 [readmex][readmex]. \u003cbr /\u003e\nReleased under the [MIT][license-url] license.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- CONTACT --\u003e\n## 📧 Contact\n\nEmail: lintaothu@foxmail.com\n\nProject Link: [https://github.com/aibox22/readmex](https://github.com/aibox22/readmex)\n\nQQ Group: 2161023585 (Welcome to join our QQ Group to discuss and get help!)\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"images/group_qr.png\" alt=\"QQ Group QR Code\" width=\"200\"\u003e\n  \u003cp\u003e\u003cem\u003eScan QR code to join our QQ Group\u003c/em\u003e\u003c/p\u003e\n\u003c/div\u003e\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\u003c!-- REFERENCE LINKS --\u003e\n[readmex]: https://github.com/aibox22/readmex\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n[contributors-shield]: https://img.shields.io/github/contributors/aibox22/readmex.svg?style=flat-round\n[contributors-url]: https://github.com/aibox22/readmex/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/aibox22/readmex.svg?style=flat-round\n[forks-url]: https://github.com/aibox22/readmex/network/members\n[stars-shield]: https://img.shields.io/github/stars/aibox22/readmex.svg?style=flat-round\n[stars-url]: https://github.com/aibox22/readmex/stargazers\n[issues-shield]: https://img.shields.io/github/issues/aibox22/readmex.svg?style=flat-round\n[issues-url]: https://github.com/aibox22/readmex/issues\n[release-shield]: https://img.shields.io/github/v/release/aibox22/readmex?style=flat-round\n[release-url]: https://github.com/aibox22/readmex/releases\n[release-date-shield]: https://img.shields.io/github/release-date/aibox22/readmex?color=9cf\u0026style=flat-round\n[license-shield]: https://img.shields.io/github/license/aibox22/readmex.svg?style=flat-round\n[license-url]: https://github.com/aibox22/readmex/blob/master/LICENSE.txt\n[Python]: https://img.shields.io/badge/Python-3776AB?style=flat-round\u0026logo=python\u0026logoColor=white\n[Python-url]: https://www.python.org/\n[OpenAI]: https://img.shields.io/badge/OpenAI-000000?style=flat-round\u0026logo=openai\u0026logoColor=white\n[OpenAI-url]: https://openai.com/\n[Flask]: https://img.shields.io/badge/Flask-000000?style=flat-round\u0026logo=flask\u0026logoColor=white\n[Flask-url]: https://flask.palletsprojects.com/\n[Rich]: https://img.shields.io/badge/Rich-000000?style=flat-round\u0026logo=rich\u0026logoColor=white\n[Rich-url]: https://rich.readthedocs.io/\n\n\u003c!-- STAR HISTORY --\u003e\n## ⭐ Star History\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://star-history.com/#aibox22/readmex\u0026Date\"\u003e\n    \u003cimg src=\"https://api.star-history.com/svg?repos=aibox22/readmex\u0026type=Date\" alt=\"Star History Chart\" width=\"800\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faibox22%2Freadmex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faibox22%2Freadmex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faibox22%2Freadmex/lists"}