Thus Readme Master

CLI Tool · Zero-Prompt README Automation

v1.0.0

Overview

Thus-Readme-Master is a zero-prompt CLI that auto-generates professional README.md files by deeply analyzing your project architecture, dependencies, and business logic — no API key, no questions asked.

Run one command at the root of any project. Thus-Readme-Master scans every file recursively, detects your frameworks, infers your domain, audits your security posture, scores your project health, and writes a production-ready README in seconds.

100% local. No cloud. No cost. No data leaves your machine.

Project Structure

├── bin/
│   └── thus.js
├── src/
│   ├── analyzers/
│   │   ├── ecosystem.js
│   │   ├── git.js
│   │   ├── health.js
│   │   ├── scanner.js
│   │   └── security.js
│   ├── generators/
│   │   └── readme.js
│   └── utils/
│       ├── config.js
│       ├── format.js
│       └── logger.js
├── tests/
│   ├── health.test.js
│   ├── scanner.test.js
│   └── security.test.js
├── .github/
│   └── workflows/
│       └── ci.yml
├── .env.example
├── .thusrc.example
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
└── package.json

Features

• Zero-Prompt — one command, complete README. No questions.
• Deep semantic analysis — detects frameworks, business domain, entry points.
• Multi-ecosystem — Node.js, Python, Go, PHP, Rust.
• Framework detection — React, Next.js, Vue, Express, NestJS, Fastify, Prisma, Stripe, and 20+ more.
• Security audit — scans for 10 secret patterns (API keys, JWT, DB URLs, private keys...).
• Project health score — 10-point checklist with grade A–F.
• File tree renderer — visual architecture snapshot at configurable depth.
• Git-aware — reads contributors, bus factor, last commit, and latest tag.
• .thusrc support — optional config for advanced users.
• Dry-run mode — preview without writing.

Prerequisites

• Node.js >= 16.0.0

Installation

# Install globally from npm
npm install -g thus-readme-master

# Or run directly with npx
npx thus-readme-master

Usage

# Run at the root of any project
thus

# Specify output file
thus --output DOCS.md

# Preview without writing
thus --dry-run

# Force overwrite existing README
thus --force

# Skip specific sections
thus --no-health --no-security

# Use a custom config file
thus --config path/to/.thusrc

CLI Options

| Flag | Default | Description | |---|---|---| | -o, --output <path> | README.md | Output file path | | -f, --force | false | Overwrite without confirmation | | --no-health | — | Skip health score section | | --no-security | — | Skip security audit | | --no-tree | — | Skip file tree | | --dry-run | false | Preview in terminal only | | --config <path> | auto-detected | Path to .thusrc |

Configuration via .thusrc

Place a .thusrc file at the root of your project to customize behavior:

{
  "exclude": ["secret_folder", "internal/**"],
  "name": "My Project",
  "maxTreeDepth": 4,
  "sections": {
    "tree": true,
    "health": true,
    "security": true,
    "contributors": true
  }
}

Security

Thus-Readme-Master never sends your code anywhere. All analysis is performed locally using regex pattern matching and file parsing. No telemetry, no network calls, no cloud dependencies.

The security auditor scans your source files for:

• AWS credentials and secret keys
• Generic API keys and passwords
• JWT tokens and private key blocks
• Database connection strings (MongoDB, Postgres, MySQL, Redis)
• Stripe live/test keys and GitHub tokens

Findings appear as warnings in the generated README, prompting you to move secrets to .env.

Project Health

Score: 100/100 — Grade A (Excellent)

| Check | Status | Points | |---|---|---| | README present | Pass | 10/10 | | License file | Pass | 15/15 | | .gitignore present | Pass | 10/10 | | .env.example present | Pass | 10/10 | | CONTRIBUTING guide | Pass | 10/10 | | CHANGELOG present | Pass | 5/5 | | Test suite detected | Pass | 20/20 | | CI/CD configured | Pass | 10/10 | | No oversized files (>500KB) | Pass | 5/5 | | No hardcoded secrets | Pass | 5/5 |

Contributing

Contributions, issues, and feature requests are welcome.

1. Fork the repository.
2. Create your feature branch: git checkout -b feature/your-feature
3. Commit your changes: git commit -m "feat: add your feature"
4. Push to the branch: git push origin feature/your-feature
5. Open a Pull Request.

Please read CONTRIBUTING.md for details — especially if you want to add new ecosystem support, detection patterns, or language templates.

Found a bug or have an idea? Open an issue.

License

This project is licensed under the MIT License — see the LICENSE file for details.

Documentation generated by Thus-Readme-Master — Zero-Prompt README automation by Malthus AMETEPE