ReadmeSync 1.3.0
dotnet tool install --global ReadmeSync --version 1.3.0
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
dotnet tool install --local ReadmeSync --version 1.3.0
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=ReadmeSync&version=1.3.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
nuke :add-package ReadmeSync --version 1.3.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
ReadmeSync
ReadmeSync is a lightweight, fast, and highly customizable command-line tool that automatically scans your source code and generates or updates a README.md or ROADMAP.md file. It extracts namespaces, classes, interfaces, public methods, XML/Javadoc/docstring summaries, and // TODO comments to give you an instant, structured overview of your project.
✨ Features
- Multi-Language Support: C#, Java, Python, TypeScript, and JavaScript 🚀
- Deep Code Insights: Extracts
class,interface,record,struct, andenumtypes. - Documentation Extraction: Automatically pulls documentation comments:
- C#:
/// <summary> - Java/TypeScript/JavaScript:
/** ... */(JSDoc/Javadoc) - Python:
"""docstrings"""
- C#:
- Inheritance Tracking: Shows which classes or interfaces your code inherits from.
- Smart Exclusions: Automatically ignores
bin,obj,node_modules,.git,.vs,__pycache__,dist, andbuild. Customizable via the--excludeflag. - Safe Updates: Keeps your manual content intact. It only replaces content below the auto-generated marker.
- GitHub Integration: Optionally generates clickable links to your source files in your repository.
- CI/CD Ready: Automated testing on multiple platforms ensures reliability.
📦 Installation
ReadmeSync is distributed as a .NET Global Tool. You can install it easily via the command line:
dotnet tool install --global ReadmeSync
To update to the latest version:
dotnet tool update --global ReadmeSync
🚀 Usage
Navigate to your project directory and run the tool:
readmesync [--lang language] [scan-root] [output-file] [optional-repo-url]
Examples
1. Basic C# Scan (Current Directory)
readmesync . README.md
2. Scan a Java Project
readmesync --lang java ./src ROADMAP.md
3. Scan a Python Project
readmesync --lang python ./app README.md https://github.com/user/repo
4. Scan a TypeScript Project
readmesync --lang typescript ./src DOCS.md
5. Generate Clickable GitHub Links
readmesync . README.md https://github.com/YOUR_USERNAME/YOUR_REPO
6. Use Emojis for Visual Appeal
readmesync --use-emojis . README.md
7. Custom Exclusions
readmesync --exclude "test,temp,cache" . README.md
🌐 Supported Languages
| Language | Extension | Status |
|---|---|---|
| C# | .cs |
✅ Full Support |
| Java | .java |
✅ Full Support |
| Python | .py |
✅ Full Support (v1.3.0+) |
| TypeScript | .ts |
✅ Full Support (v1.3.0+) |
| JavaScript | .js |
✅ Full Support (v1.3.0+) |
🔧 Command-Line Options
| Flag | Description |
|---|---|
--lang <language> |
Specify language: csharp, java, python, typescript, javascript (default: csharp) |
--use-emojis |
Enable emoji icons in the generated output |
--exclude <folders> |
Comma-separated list of folders to exclude |
--no-tracking |
Disable anonymous telemetry |
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
This package has no dependencies.