Skip to content

--gitignore / --no-gitignore

Info

  • The --gitignore flag makes show-file-tree respect .gitignore files, excluding ignored files and folders from the tree.
  • The --no-gitignore flag ignores .gitignore, showing all files and folders.

Usage

Usage

show-file-tree  --gitignore # (1)!
  1. Only files not listed in .gitignore appear.
show-file-tree  --no-gitignore # (1)!
  1. All files are displayed, even if ignored in Git.
When file is ready
Markdown tree exported to: [ROOT_PATH]\[FILE_NAME]-file-tree.md

Example

Example

__pycache__/
*.log
.env
├── 📁 src
   └── main.py
└── README.md # (1)!
  1. Ignored: __pycache__/, .env, .log files.
├── 📁 src
   ├── main.py
   └── __pycache__/main.cpython-310.pyc
├── .env
├── debug.log
└── README.md

Tips

Tip

  • Useful in CI pipelines where you want a complete file tree.
  • Combine with --hidden to show hidden files that are also ignored by Git.
  • Combine with --format md for full documentation including ignored files:

Markdown Support

Formatted with Markdown file

Not supported
show-file-tree  --no-gitignore --format md # (1)!
  1. In version v0.0.1, this feature is not supported. It has been updated in newer versions.
Not supported
show-file-tree  --hidden --gitignore --format md