🗂 Table of Contents

• About the Project
  • Usage
  • Technologies
• Installation
  • Prerequisites
  • Installing Dependencies
  • Running
  • Running Tests
• Contributing
• License
• 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:

$ npx readme-cli-gen

To generate a README for a specific project, pass the path as an argument:

$ npx readme-cli-gen /path/to/your/project

To use a custom template:

$ 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
• @types/node
• tsx
• typescript
• vitest

:bricks: Installation

:construction: Prerequisites

Clone this project repository:

$ git clone https://github.com/3salles/readme-cli-gen.git
$ cd readme-cli-gen

:construction: Installing Dependencies

$ pnpm install

:arrow_forward: Running

$ pnpm dev

:test_tube: Running Tests

$ 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.

:page_facing_up: License

This project uses MIT license.

:technologist: Author

Beatriz Salles