python -m pip install "BB-DirTree"
dirtree [OPTIONS] [ARGS]
| Short | Long | Description |
|---|
-b | --base-dir | Set base directory <br> *Uses current directory if not specified*
-d | --depth | Integer to set the depth of directory tree <br> *ex: '0' will only print the base directory list*
-D | --dotfiles | Include hidden files in tree
-e | --exclude | Filenames/directories to exclude from the tree <br> *See Exclusions*
-h | --help | This help message
-L | --follow-links | Follow links to directories - default is NOT to follow
-q | --qt-html | Print in html format for use with QT
-r | --regex | Use regex to include/exclude files/directories in tree <br> *See Regex*
-v | --verbose | Set verbose level (1-5) or 'debug' = 1
| --ignore-errors | Ignore read errors (such as permission errors) - Default is to error and exit
| --no-print | Don't print any output
| --version | Print version info and exit
It is recommended to quote all paths
Provide names of files or directories to exclude. To exclude multiple files/directories, quote entire list and seperate with a colon (:). Add a forward slash (/) to specify a directory name to exclude.
dirtree --exclude "excluded dir:excluded file"
Prefix regex with include= or exclude=
Seperate each regex with a space, quoting each individual argument.
dirtree --regex "exclude=.*\.ini$"
# will exclude any files that have a *.ini* extension.
dirtree --regex "include=.*\.mp3$"
# will include only files with a *.mp3* extension.
This has no effect on directories
Multiple regex can be used by specifying --regex multiple times.
==========
MIT License
Copyright (c) [2022] [Erik Beebe]
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
============
FAQs
Create a nice looking directory tree with options
We found that bb-dirtree demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.