readme-cli-gen 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Beatriz Salles
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,128 @@
+<p align="center">
+  <h3 align="center">readme-cli-gen</h3>
+</p>
+
+<p align="center">
+  <a href="https://github.com/3salles/readme-cli-gen">
+    <img src="https://img.shields.io/github/repo-size/3salles/readme-cli-gen?style=for-the-badge" alt="GitHub repo size">
+  </a>
+  <a href="https://github.com/3salles/readme-cli-gen">
+    <img src="https://img.shields.io/github/languages/count/3salles/readme-cli-gen?style=for-the-badge" alt="GitHub language count">
+  </a>
+  <a href="https://github.com/3salles/readme-cli-gen">
+    <img src="https://img.shields.io/github/forks/3salles/readme-cli-gen?style=for-the-badge" alt="GitHub forks">
+  </a>
+  <a href="https://github.com/3salles/readme-cli-gen/issues">
+    <img src="https://img.shields.io/github/issues/3salles/readme-cli-gen?style=for-the-badge" alt="GitHub open issues">
+  </a>
+  <a href="https://github.com/3salles/readme-cli-gen/pulls">
+    <img src="https://img.shields.io/github/issues-pr/3salles/readme-cli-gen?style=for-the-badge" alt="GitHub open pull requests">
+  </a>
+  <img src="https://img.shields.io/static/v1?label=License&message=MIT&color=0000ff&style=for-the-badge" alt="License">
+</p>
+
+## 🗂 Table of Contents
+
+- [About the Project](#book-about-the-project)
+  - [Usage](#coffee-usage)
+  - [Technologies](#computer-technologies)
+- [Installation](#bricks-installation)
+  - [Prerequisites](#construction-prerequisites)
+  - [Installing Dependencies](#construction-installing-dependencies)
+  - [Running](#arrow_forward-running)
+  - [Running Tests](#test_tube-running-tests)
+- [Contributing](#handshake-contributing)
+- [License](#page_facing_up-license)
+- [Author](#technologist-author)
+
+## :book: About The Project
+
+`readme-cli-gen` is a CLI tool that generates README.md files by scanning your project's structure. It automatically detects technologies, configuration files, and scripts — then asks only for the information it couldn't find. Each section is optional and only suggested when the relevant files or scripts are present in your project.
+
+### :coffee: Usage
+
+The easiest way to use `readme-cli-gen` is via `npx`, with no installation needed:
+
+```bash
+$ npx readme-cli-gen
+```
+
+To generate a README for a specific project, pass the path as an argument:
+
+```bash
+$ npx readme-cli-gen /path/to/your/project
+```
+
+To use a custom template:
+
+```bash
+$ npx readme-cli-gen /path/to/your/project /path/to/template.md
+```
+
+The tool scans your project and suggests sections based on what it finds:
+
+| What it detects                                       | Section suggested     |
+| ----------------------------------------------------- | --------------------- |
+| `package.json`                                        | Technologies          |
+| `.env.example`                                        | Environment Variables |
+| `Dockerfile` / `docker-compose.yml`                   | Docker                |
+| Test scripts (`test`, `vitest`, `jest`) or test files | Running Tests         |
+| `LICENSE` / `package.json` license field              | License               |
+| `git config` / `remote.origin.url`                    | Author                |
+
+### :computer: Technologies
+
+- [@clack/prompts](https://npmjs.com/package/@clack/prompts)
+- [@types/node](https://npmjs.com/package/@types/node)
+- [tsx](https://npmjs.com/package/tsx)
+- [typescript](https://npmjs.com/package/typescript)
+- [vitest](https://npmjs.com/package/vitest)
+
+## :bricks: Installation
+
+### :construction: Prerequisites
+
+Clone this project repository:
+
+```bash
+$ git clone https://github.com/3salles/readme-cli-gen.git
+$ cd readme-cli-gen
+```
+
+### :construction: Installing Dependencies
+
+```bash
+$ pnpm install
+```
+
+### :arrow_forward: Running
+
+```bash
+$ pnpm dev
+```
+
+### :test_tube: Running Tests
+
+```bash
+$ pnpm test
+```
+
+## :handshake: Contributing
+
+To contribute to readme-cli-gen, follow these steps:
+
+1. Fork this repository.
+2. Create a branch: `git checkout -b <branch_name>`.
+3. Make your changes and commit: `git commit -m '<commit_message>'`
+4. Push to the original branch: `git push origin readme-cli-gen/<local>`
+5. Create a pull request.
+
+See the GitHub docs on [how to create a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
+
+## :page_facing_up: License
+
+This project uses [MIT](LICENSE) license.
+
+## :technologist: Author
+
+[Beatriz Salles](https://github.com/3salles)

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "readme-cli-gen",
+  "version": "1.0.0",
+  "description": "CLI tool that automatically generates README.md files by reading your project's files and asking only for the missing information.",
+  "main": "dist/index.js",
+  "bin": {
+    "readme-cli-gen": "./dist/index.js"
+  },
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsx src/index.ts",
+    "start": "tsx src/index.ts",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "files": [
+    "dist",
+    "templates"
+  ],
+  "keywords": [
+    "readme",
+    "generator",
+    "cli",
+    "markdown"
+  ],
+  "author": "Beatriz Salles",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^25.3.5",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
+  },
+  "dependencies": {
+    "@clack/prompts": "^1.1.0"
+  }
+}

package/templates/default.md

@@ -0,0 +1,141 @@
+<p align="center">
+  <h3 align="center">{{project_name}}</h3>
+</p>
+
+<p align="center">
+  <a href="https://github.com/{{github_user}}/{{project_name}}">
+    <img src="https://img.shields.io/github/repo-size/{{github_user}}/{{project_name}}?style=for-the-badge" alt="GitHub repo size">
+  </a>
+  <a href="https://github.com/{{github_user}}/{{project_name}}">
+    <img src="https://img.shields.io/github/languages/count/{{github_user}}/{{project_name}}?style=for-the-badge" alt="GitHub language count">
+  </a>
+  <a href="https://github.com/{{github_user}}/{{project_name}}">
+    <img src="https://img.shields.io/github/forks/{{github_user}}/{{project_name}}?style=for-the-badge" alt="GitHub forks">
+  </a>
+  <a href="https://github.com/{{github_user}}/{{project_name}}/issues">
+    <img src="https://img.shields.io/github/issues/{{github_user}}/{{project_name}}?style=for-the-badge" alt="GitHub open issues">
+  </a>
+  <a href="https://github.com/{{github_user}}/{{project_name}}/pulls">
+    <img src="https://img.shields.io/github/issues-pr/{{github_user}}/{{project_name}}?style=for-the-badge" alt="GitHub open pull requests">
+  </a>
+  {{#if license_badge}}<img src="https://img.shields.io/static/v1?label=License&message={{license}}&color=0000ff&style=for-the-badge" alt="License">{{/if}}
+</p>
+
+## 🗂 Table of Contents
+
+{{table_of_contents}}
+
+## :book: About The Project
+
+{{description}}
+
+{{#if usage_command}}
+
+### :coffee: Usage
+
+To use {{project_name}}, run the following command:
+
+```bash
+$ {{usage_command}}
+```
+
+{{/if}}
+
+### :computer: Technologies
+
+{{tech_list}}
+
+## :bricks: Installation
+
+### :construction: Prerequisites
+
+Clone this project repository:
+
+```bash
+$ git clone https://github.com/{{github_user}}/{{project_name}}.git
+$ cd {{project_name}}
+```
+
+### :construction: Installing Dependencies
+
+```bash
+$ npm install
+```
+
+{{#if env_vars}}
+
+### :wrench: Environment Variables
+
+Create a `.env` file with the following keys:
+
+```
+{{env_vars}}
+```
+
+{{/if}}
+
+{{#if has_docker}}
+
+### :whale: Running with Docker
+
+```bash
+$ docker build -t {{project_name}} .
+$ docker run -d -p {{docker_port}}:{{docker_port}} {{project_name}}
+```
+
+{{/if}}
+
+{{#if run_command}}
+
+### :arrow_forward: Running
+
+```bash
+$ {{run_command}}
+```
+
+{{/if}}
+
+{{#if test_command}}
+
+### :test_tube: Running Tests
+
+```bash
+$ {{test_command}}
+```
+
+{{/if}}
+
+## :handshake: Contributing
+
+To contribute to {{project_name}}, follow these steps:
+
+1. Fork this repository.
+2. Create a branch: `git checkout -b <branch_name>`.
+3. Make your changes and commit: `git commit -m '<commit_message>'`
+4. Push to the original branch: `git push origin {{project_name}}/<local>`
+5. Create a pull request.
+
+See the GitHub docs on [how to create a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
+
+{{#if contributors_table}}
+
+## 🤝 Contributors
+
+Thanks to the following people who contributed to this project:
+
+{{contributors_table}}
+{{/if}}
+
+{{#if license}}
+
+## :page_facing_up: License
+
+This project uses [{{license}}](LICENSE) license.
+{{/if}}
+
+{{#if author}}
+
+## :technologist: Author
+
+[{{author}}](https://github.com/{{github_user}})
+{{/if}}