Skip to content

Latest commit

 

History

History
118 lines (77 loc) · 3.47 KB

README.md

File metadata and controls

118 lines (77 loc) · 3.47 KB
Raw

🚀 Orbit Directory Mapper

💡 Unlock the power of directory management with Orbit Directory Mapper! View your file structures in ASCII, JSON, or YAML formats. 🌐 Effortlessly create directory trees using descriptive JSON files. Elevate your file organization game with ease. 🚀🌳

📜 Table of Contents

🚀 Features

  • Visualization in ASCII, JSON, or YAML of a folder's structure.
  • Creation of tree structures from JSON descriptions.
  • Coming soon: Export & Compression of a folder's structure in JSON or YAML format.
  • Installation in one command.
  • Lightning-fast.
  • Easy to customize.

🛠 Prerequisites

  • Python installed on your machine.
  • Pip installed on your machine.

📥 Installation

🚀 Installation on Windows

  • Execute this command as Admin:
pip install directory-mapper --force

Note: For updates, simply run the same command again.

🐧 Installation on Linux

sudo pip install directory-mapper --force

For updates, simply run the install command again.

🗑️ Uninstallation

sudo pip uninstall directory-mapper

🧑‍💻 Usage

View Command (Default)

This command is used to visualize the directory structure in ASCII art.

dirmap view \[--ignore <folder1 folder2>\] \[--regex <regex\_pattern>\] \[--format <json/yaml>\] <folder\_path>
  • folder_path: Path of the directory to explore.
  • --ignore (optional): Specify folders to ignore.
  • --regex (optional): Use a regex pattern to ignore certain folders.
  • --format (optional): Display the directory structure in JSON or YAML format.

Create Command

Use this command to create a directory structure based on a description file.

dirmap create --description <description\_file.json> \[--ignore <folder1 folder2>\] \[--regex <regex\_pattern>\] <folder\_path>
  • folder_path: Path of the directory where the structure will be created.
  • --description: Path of the JSON description file for the directory structure.
  • --ignore (optional): Specify folders to ignore.
  • --regex (optional): Use a regex pattern to ignore certain folders.

Check-Update Command

This command checks for updates from the remote repository and provides instructions for the update.

dirmap check-update

🖼️ Screenshots

See the Assets Folder for more screens.

🔄 Updates

Follow the project's updates.

🤝 Contributions

Contributions are welcome! Check the contribution guide to get started.

📄 License

This project is under the MIT license. Check the LICENSE file for more details.