A powerful CLI tool to visualize and recreate directory structures with smart ignore rules
Project description
showmydir
A powerful CLI tool to visualize, export, and recreate directory structures with smart ignore rules.
Features
- Tree View — Beautiful directory tree output
- Flat View — List files in a simple format
- Smart Ignore System
- Built-in ignores (Python, Node, Git, etc.)
- Custom ignore support
.smdFormat- Save directory structures
- Recreate them anywhere
- Search Support (inside .smd)
- Fast & Lightweight
- Rich CLI output powered by rich
Installation
Using pipx (recommended)
pipx install showmydir
Useing pip
pip install showmydir
Usage
Show directory tree
showmydir tree --root ./my_project
Flat mode
showmydir tree --mode flat
Save structure to .smd
showmydir tree --output project.smd
Recreate structure from .smd
showmydir create-tree project.smd
Ignore Options
Enable smart ignores:
showmydir tree --python --git --node
Available categories:
--python-ignore--node-ignore--git-ignore--docker-ignore--editor-ignore--rust-ignore--uv--ignore
How .smd Works
.smd is a lightweight format that stores directory structure.
- directory tree
- file structure
- metadata (size, counts, etc.)
You can:
- Save it
- Share it
- Recreate it anywhere
It allows you to recreate projects instantly without scaning disk again and again.
Security
- All file and directory names are sanitized
- Prevents path traversal (e.g. ../)
- Safe to use for recreating directory structures
Author
Aditya Pratap Singh Rathore
License
MIT License © Aditya Pratap Singh Rathore
Project details
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file showmydir-0.2.0.tar.gz.
File metadata
- Download URL: showmydir-0.2.0.tar.gz
- Upload date:
- Size: 14.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bd249e42e8c5906dab8a724b4c75a7c7123e0bc6f70ad84c27e1a11218f14f5c
|
|
| MD5 |
28fa53cd6a2fe5663e2dbd8f1b8655aa
|
|
| BLAKE2b-256 |
9fb28be7db4d5fa8e8833c305e1c87e36b1510fc0d27a7d00278a496b664b872
|
File details
Details for the file showmydir-0.2.0-py3-none-any.whl.
File metadata
- Download URL: showmydir-0.2.0-py3-none-any.whl
- Upload date:
- Size: 17.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
47c7c554676e5b693f9c1fa0a1b7c6ef462c0d6f387745099c0c0f648bca8762
|
|
| MD5 |
982199e657485e25fc9f74d6cff3d32e
|
|
| BLAKE2b-256 |
a719f301670f7752a88ede14e75c74a6722dd2be7830b65f15fd1cf072670df9
|