{"id":25939576,"url":"https://github.com/samueltuoyo15/dokugen","last_synced_at":"2026-02-11T16:04:03.541Z","repository":{"id":278147658,"uuid":"934372723","full_name":"samueltuoyo15/Dokugen","owner":"samueltuoyo15","description":"Lightweight README.md file Generator CLI. It simplifies the process of writing your README.md file from scratch by generating professional README.md files for your projects, saving you time.  The idea behind Dokugen is simple but impactful, automate the most neglected part of a repo. The results cleaner projects and happier contributors","archived":false,"fork":false,"pushed_at":"2025-11-29T12:30:04.000Z","size":13456,"stargazers_count":253,"open_issues_count":3,"forks_count":20,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-12-23T18:50:40.534Z","etag":null,"topics":["api-documentation","readme-generator"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/dokugen","language":"TypeScript","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/samueltuoyo15.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["Samueltuoyo15"]}},"created_at":"2025-02-17T18:08:30.000Z","updated_at":"2025-12-22T21:27:05.000Z","dependencies_parsed_at":null,"dependency_job_id":"d79f18cb-edd6-4146-a2c7-4c14c84a0431","html_url":"https://github.com/samueltuoyo15/Dokugen","commit_stats":null,"previous_names":["samueltuoyo15/dokugen"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/samueltuoyo15/Dokugen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samueltuoyo15%2FDokugen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samueltuoyo15%2FDokugen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samueltuoyo15%2FDokugen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samueltuoyo15%2FDokugen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/samueltuoyo15","download_url":"https://codeload.github.com/samueltuoyo15/Dokugen/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samueltuoyo15%2FDokugen/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29337018,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-11T16:00:30.228Z","status":"ssl_error","status_checked_at":"2026-02-11T16:00:25.398Z","response_time":97,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["api-documentation","readme-generator"],"created_at":"2025-03-04T04:17:59.218Z","updated_at":"2026-02-11T16:04:03.535Z","avatar_url":"https://github.com/samueltuoyo15.png","language":"TypeScript","funding_links":["https://github.com/sponsors/Samueltuoyo15"],"categories":[],"sub_categories":[],"readme":"# Dokugen\n\n![Demo GIF](./public/Demo.gif)\n\nDokugen is a lightweight README.md file Generator Command Line Interface Tool. It simplifies the process of writing your README.md file from scratch by generating professional README.md files for your projects, saving you time and ensuring consistency using AI. The idea behind Dokugen is simple but impactful, automate the most neglected part of a repo. The results cleaner projects and happier contributors\n\n## Usage\n\n### Install Dokugen globally once, and use forever (Recommended)\n\n```bash\nnpm install -g dokugen\n# or\nyarn global add dokugen\n# or\npnpm install -g dokugen\n```\n\n### Or Download Standalone Binary (No Node.js Required)\n\nGrab the executable for your OS from the [Releases page](https://github.com/samueltuoyo15/Dokugen/releases).\n\n**Windows:**\nDownload `dokugen-windows-x64.exe` and run it from your command prompt.\n\n**macOS / Linux:**\n```bash\n# Example for Linux\ncurl -L -o dokugen https://github.com/samueltuoyo15/Dokugen/releases/latest/download/dokugen-linux-x64\nchmod +x dokugen\n./dokugen --version\n```\n\n### Navigate to the project you want to work with\n\n```bash\ncd my-project\n```\n\n### Generate a new README interactively\n\n```bash\ndokugen generate\n```\n\n\u003e This command launches an interactive prompt to guide you through creating a professional README file.\n\n---\n\n### Generate README with template\n\n```bash\ndokugen generate --template https://raw.githubusercontent.com/username/repo-name/blob/main/README.md\n```\n\n\u003e Use a custom GitHub repo readme file as a template to generate a concise and strict readme for your project.\n\n---\n\n### Update Existing README (Smart Update)\n\n```bash\ndokugen update\n```\n\n\u003e **NEW!** Intelligently updates only auto-generated sections of your README while preserving all your custom content. Perfect for keeping your README fresh as your project evolves without losing your personal touch.\n\n**What gets updated:**\n- Tech stack and dependencies\n- API documentation\n- Installation instructions\n- Features list\n\n**What stays safe:**\n- Your custom introductions\n- Personal badges and links\n- Custom examples\n- Manual sections you've added\n\n---\n\n### Check Version\n\n```bash\ndokugen --version\n```\n\n\u003e Displays Current Version (3.11.0)\n\n## Features\n\n- **Auto-Update System**: Dokugen automatically checks for new versions and updates itself when you run any command. Always stay current!\n- **Smart README Updates**: Update your README without losing custom content. Only auto-generated sections get refreshed.\n- **Automated Generation**: Automatically analyzes your project and generates a comprehensive README.\n- **Real-Time Streaming**: Watch your README populate in real-time as it's being generated.\n- **Compression Technology**: Handles large codebases efficiently with 70-90% payload size reduction.\n- **Easy to Use**: Simple command-line interface for quick and easy README creation.\n- **Cross-Platform**: Works seamlessly on Windows, macOS, and Linux.\n- **Programming Language and Framework Agnostic**: Works with any language (e.g., Python, JavaScript, Go, C#, C, Rust, etc.)\n- **Options \u0026 Flags**: Supports flags and options like generating from a template, overwriting existing files, etc.\n\n### Programming Language \u0026 Framework Compatibility\n\n![Generate Readme - Language \u0026 Framework agnostic](./public/Generate%20Readme%20-%20Language%20\u0026%20Framework%20agnostic.png)\n\n### Review from Github Projects Community\n\n![Review from Github Projects Community](./public/reviews.png)\n             |\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Contributing\n\nContributions are welcome! [Read the contribution guide here.](https://github.com/samueltuoyo15/Dokugen/blob/main/CONTRIBUTION.md)\n\n## Author\n\n- **Samuel Tuoyo**\n- [Twitter](https://x.com/TuoyoS26091)\n- [LinkedIn](https://www.linkedin.com/in/samuel-tuoyo-8568b62b6)\n\n## Badges\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://opensource.org/)\n[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)\n[![Readme was generated by Dokugen](https://img.shields.io/badge/Readme%20was%20generated%20by-Dokugen-brightgreen)](https://www.npmjs.com/package/dokugen)\n[![Made in Nigeria](https://img.shields.io/badge/made%20in-nigeria-008751.svg?style=flat-square)](https://github.com/acekyd/made-in-nigeria)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamueltuoyo15%2Fdokugen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamueltuoyo15%2Fdokugen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamueltuoyo15%2Fdokugen/lists"}