Directory Mapper - A tool for mapping directories and visualizing file structures.
Project description
🚀 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.
- Git installed on your machine.
📥 Installation
🚀 Installation on Windows
Set-ExecutionPolicy RemoteSigned; Invoke-WebRequest 'https://raw.githubusercontent.com/orbitturner/directory-mapper/main/setups/windows-installer.ps1' | Invoke-Expression
Note: For updates, simply run the same command again.
🐧 Installation on Linux
wget https://raw.githubusercontent.com/orbitturner/directory-mapper/main/setups/linux-installer.sh && sudo bash linux-installer.sh
For updates, simply run the same command again.
🧑💻 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for directory_mapper-1.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb8a7abdfb02163c02e4e34309f6c38536610db8849f8139754a7d0dbd72364f |
|
MD5 | 9d67510813443eec0418532852959f27 |
|
BLAKE2b-256 | 1e35bbfc29a26e28801b928a9bbcca34ec9bcc12335cf986c0789f7dd3b8b085 |