Skip to main content

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
  • .smd Format
    • 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
  • --node
  • --git
  • --docker
  • --editor
  • --rust
  • --uv

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

showmydir-0.1.2.tar.gz (13.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

showmydir-0.1.2-py3-none-any.whl (15.8 kB view details)

Uploaded Python 3

File details

Details for the file showmydir-0.1.2.tar.gz.

File metadata

  • Download URL: showmydir-0.1.2.tar.gz
  • Upload date:
  • Size: 13.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for showmydir-0.1.2.tar.gz
Algorithm Hash digest
SHA256 bcd2849736277a4e220f043f142fd82d15ea2d152226f8a2ee4dcf2ef7955ef0
MD5 44e5d3dd5f0493528e08c529b0954418
BLAKE2b-256 28f0550c598351efb8c81dc1c55f222a215b35d696cd7b2054ecd9caa8e7ee5f

See more details on using hashes here.

File details

Details for the file showmydir-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: showmydir-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 15.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for showmydir-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8996e56d0454581a97d9421ddfdca7c00f0208d7424e799374ba61d9b908fd59
MD5 3fabdc896372f46d49c1611d43b54c95
BLAKE2b-256 f00f916b794b797a133313961e56e39f8d3d6db4e973d65574d026971dc6aca4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page