Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/orbitturner/directory-mapper
🗃️ View your directories in ASCII, JSON or YAML tree 🚀! Or Create Full Directories Tree with a JSON description. 📂 Simplify your file and folder tooling experience. 🚀
https://github.com/orbitturner/directory-mapper
directory hacktoberfest toolkit tree-structure
Last synced: 5 days ago
JSON representation
🗃️ View your directories in ASCII, JSON or YAML tree 🚀! Or Create Full Directories Tree with a JSON description. 📂 Simplify your file and folder tooling experience. 🚀
- Host: GitHub
- URL: https://github.com/orbitturner/directory-mapper
- Owner: orbitturner
- License: other
- Created: 2023-10-09T15:31:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-19T11:36:44.000Z (11 months ago)
- Last Synced: 2025-01-15T22:38:20.739Z (28 days ago)
- Topics: directory, hacktoberfest, toolkit, tree-structure
- Language: Python
- Homepage: https://pypi.org/project/directory-mapper/
- Size: 14 MB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 🚀 **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](#features)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [On Windows](#on-windows)
- [On Linux](#on-linux)
- [Usage](#usage)
- [View Command (Default)](#view-command-default)
- [Create Command](#create-command)
- [Check-Update Command](#check-update-command)
- [Updates](#updates)
- [Contributions](#contributions)
- [License](#license)
---
## 🚀 **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:
```bash
pip install directory-mapper --force
```
> **Note:** For updates, simply run the same command again.
### 🐧 **Installation on Linux**
```bash
sudo pip install directory-mapper --force
```
For updates, simply run the install command again.
### 🗑️ **Uninstallation**
```bash
sudo pip uninstall directory-mapper
```
## 🧑💻 **Usage**
### View Command (Default)
This command is used to visualize the directory structure in ASCII art.
```shell
dirmap view \[--ignore \] \[--regex \] \[--format \]
```
- `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.
```shell
dirmap create --description \[--ignore \] \[--regex \]
```
- `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.
```shell
dirmap check-update
```
## 🖼️ **Screenshots**
See the [Assets Folder](https://github.com/orbitturner/directory-mapper/tree/main/.assets) for more screens.
## 🔄 **Updates**
Follow the [project's updates](https://github.com/orbitturner/directory-mapper/blob/main/versions-history.json).
## 🤝 **Contributions**
Contributions are welcome! Check the [contribution guide](https://github.com/orbitturner/directory-mapper/blob/main/CONTRIBUTING.md) to get started.
## 📄 **License**
This project is under the MIT license. Check the [LICENSE](https://github.com/orbitturner/directory-mapper/blob/main/LICENSE.md) file for more details.