Nirman-cli 0.1.8

A CLI tool to create project folder structures from a markdown file.

Nirman-cli

A simple and powerful CLI tool to create project folder and file structures from a Markdown tree.

Stop creating files and folders manually. Define your project's skeleton in a readable Markdown file and let nirman build it for you in seconds.

Key Features

• Intuitive Input: Uses a visual, tree-style Markdown format.
• Safe by Default: Includes a --dry-run mode to preview changes.
• Flexible: Supports overwriting files with the --force flag.
• Simple & Lightweight: No external dependencies.

Installation

You can install Nirman-cli directly from PyPI:

pip install Nirman-cli

Usage

1. Create a Markdown file (e.g., structure.md) defining your desired project layout:

   my-python-app/
   ├── src/
   │   ├── __init__.py
   │   └── main.py
   ├── tests/
   │   └── test_main.py
   ├── .gitignore
   └── README.md
   

2. Run the nirman command from your terminal:

   nirman structure.md
   

   This will create the my-python-app/ directory and all its contents in your current location.

Command-Line Options

usage: nirman [-h] [-o OUTPUT] [--dry-run] [-f] input_file

Build a project structure from a Markdown tree file.

positional arguments:
  input_file            Path to the Markdown file containing the project structure (must have a .md or .markdown extension).

options:
  -h, --help            show this help message and exit
  -o OUTPUT, --output OUTPUT
                        Target directory where the structure will be created (default: current directory).
  --dry-run             Print the actions that would be taken without creating any files or directories.
  -f, --force           Overwrite existing files if they are encountered.

License

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