🚀 Markdown-CLI

A powerful CLI tool for scanning, extracting, and merging Markdown files

📌 Overview

Markdown-CLI is a Node.js-powered command-line tool that recursively scans a directory for Markdown (.md) files, extracts tables, merges content, and saves the result into a consolidated .md file.

🔹 Perfect for: Processing documentation repositories, extracting structured tabular data from Markdown, and automating content merging in large Markdown projects.

✨ Features

✅ Recursive scanning – Finds all Markdown files in the directory and subdirectories
✅ Table extraction – Extracts and merges only Markdown tables while preserving structure
✅ File path tracking – Displays which file each table comes from
✅ Custom output filename – Allows specifying output file name
✅ Error handling – Detects missing directories, invalid files, and other common issues
✅ Modern CLI experience – Uses chalk and ora for a professional terminal UI

📥 Installation

To install the CLI, you can either install it globally via npm or clone the repository manually.

1️⃣ Install globally via npm

npm install -g markdown-cli-tool

2️⃣ Clone the repository manually

git clone https://github.com/johan-hagman/markdown-CLI.git
cd markdown-CLI
npm install

🚀 Usage

Once installed, run the CLI tool with:

markdown-cli <directory> [output-file]

🔹 Example:

markdown-cli documents

This scans the documents/ folder, extracts tables, and merges them into merged.md.

To specify a custom output filename, run:

markdown-cli documents output.md

This saves the merged tables into output.md.

If running via npm scripts, use:

npm start documents myOutput.md

⚙️ Parameters

Argument	Description
<directory>	The folder to scan for .md files
<directory> [output]	Saves output to a custom filename

🛠️ Development & Contributing

🚧 Tests are not yet implemented in this version, but will be added in a future release to ensure robustness and reliability.

📌 Planned tests include:

• Valid Markdown files with tables
• Markdown files without tables
• Handling of non-Markdown files
• Nonexistent or empty directories

💡 Want to contribute? Fork the repo, open issues, or submit pull requests.

Run locally for development:

git clone https://github.com/johan-hagman/markdown-CLI.git
cd markdown-CLI
npm install
npm link   # Links CLI tool globally for local testing

You can now use it like any global CLI:

markdown-cli test-folder

📜 License

This project is licensed under the MIT License. Want to contribute? Fork the repo and submit a PR! 🚀

📌 Final Notes

🚀 This tool is built for efficiency, automation, and ease of use. If you find it useful, consider giving it a ⭐ on GitHub!

Happy codingstart!