Skip to main content

A simple CLI tool to print and save your project directory structure

Project description

DirBuilder

A simple CLI tool to print and save your project directory structure — useful for documentation, README files, and sharing project layouts.


Install

pip install dirbuilder

Usage

Navigate to your project root and run:

dirbuilder

To skip specific folders or files, pass them as arguments:

dirbuilder node_modules build dist .env venv

Example Output

my-app
├── public
│   └── index.html
├── src
│   ├── main.jsx
│   └── pages
│       ├── about.jsx
│       └── home.jsx
├── package.json
└── structure.txt

The tree is printed to the terminal and also saved as structure.txt in the current directory.


Skipped by Default

These are always skipped without needing to pass them:

  • .git
  • __pycache__
  • .DS_Store
  • .idea
  • .vscode

License

MIT

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

dirbuilder-0.1.1.tar.gz (2.7 kB view details)

Uploaded Source

Built Distribution

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

dirbuilder-0.1.1-py3-none-any.whl (3.2 kB view details)

Uploaded Python 3

File details

Details for the file dirbuilder-0.1.1.tar.gz.

File metadata

  • Download URL: dirbuilder-0.1.1.tar.gz
  • Upload date:
  • Size: 2.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for dirbuilder-0.1.1.tar.gz
Algorithm Hash digest
SHA256 e11ac57918cdb7c7f4f59649dee40508bce0ca4385c91bfa5da72138d5856f55
MD5 50133e5df7616b9b02c0cb282018bf24
BLAKE2b-256 901b179ee083d60cf055b609182f5a885ce423410042e246b5f5c5c77108e35c

See more details on using hashes here.

File details

Details for the file dirbuilder-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: dirbuilder-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 3.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for dirbuilder-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dbb2478980fd91f8d05d8dfa68cedbc3c7c65de291f1afa1be579ddf49a37013
MD5 5ae63c7652cccfe4fef619a614c6cb9e
BLAKE2b-256 42b7eb9d5e46b07fabfa2e1594ce0c8e0fda6ba8fe9d5558cd05cdd23c953f7c

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