🧾 PSDirectoryTree 📁

PSDirectoryTree is a PowerShell module for visualizing directory structures in a clear, tree-like format. It supports .gitignore filtering, JSON output, progress indication, and optional file export — making it ideal for documentation, automation, or codebase exploration.

✨ Features

Tree view of any directory
Honors .gitignore rules by default (optional)
JSON output support (-AsJson)
Write to file with -OutputFile
Color-coded output for common file types
Built-in progress feedback via Write-Progress

🔧 Installation

Install the module from PowerShell Gallery:

Install-Module PSDirectoryTree -Scope CurrentUser

📦 View on PowerShell Gallery

🚀 Usage Examples

Visual tree in the console

Get-DirectoryTree -RootPath "."

Output as JSON

Get-DirectoryTree -RootPath "." -AsJson

Save tree output to a file

Get-DirectoryTree -RootPath "." -OutputFile ".\tree.txt"

Save JSON structure to file

Get-DirectoryTree -RootPath "." -AsJson -OutputFile ".\structure.json"

⚙️ Parameters

Parameter	Description
`RootPath`	The root directory to scan.
`MaxDepth`	Maximum depth to traverse (default: `100`).
`Filter`	Filter output: `All`, `Folders`, or `Files`.
`IgnoreGitIgnore`	Skip `.gitignore` filtering.
`AsJson`	Output the result as a JSON object.
`OutputFile`	File path to save the output. Works with text or JSON.

🖼️ Example Output

project-root
├── src
│   ├── index.ts
│   └── app.ts
├── dist
│   └── bundle.js
└── README.md

📁 GitIgnore Integration

Per-directory parsing of .gitignore
Respects common patterns (wildcards, trailing slashes, folders).
Use -IgnoreGitIgnore to disable filtering entirely.

🧾 JSON Structure

When -AsJson is used, the output will look like this:

{
  "Name": "project-root",
  "Path": "C:\\Path\\To\\project-root",
  "Type": "Folder",
  "Children": [
    {
      "Name": "index.html",
      "Path": "C:\\Path\\To\\project-root\\index.html",
      "Type": "File",
      "Children": []
    },
    {
      "Name": "src",
      "Path": "C:\\Path\\To\\project-root\\src",
      "Type": "Folder",
      "Children": [
        {
          "Name": "main.ts",
          "Path": "C:\\Path\\To\\project-root\\src\\main.ts",
          "Type": "File",
          "Children": []
        }
      ]
    }
  ]
}

This format is ideal for further processing, such as feeding into frontend tools, documentation systems, or CI reports.

🎨 Output Colors

Type	Color
Folder	Cyan
`.ts`	Blue
`.js`	Yellow
`.css`	Green
`.html`	Magenta
`.json`	Dark Yellow
Other files	Gray

✅ License

This project is licensed under the MIT License.

Maintained by Vikansys AB