Skip to content

Commit a948a1f

Browse files
authored
Update README.md
1 parent 9267ecc commit a948a1f

File tree

1 file changed

+34
-91
lines changed

1 file changed

+34
-91
lines changed

README.md

Lines changed: 34 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ A modern replacement for the `tree` command that lets you explore directory stru
88
![Platform](https://img.shields.io/badge/platform-windows%20%7C%20macOS%20%7C%20linux-blue)
99
![PowerShell Version](https://img.shields.io/badge/PowerShell-7.0%2B-blue)
1010

11-
## Preview Video
11+
## Preview Videos
1212

13-
https://github.com/user-attachments/assets/4f5cc8ea-5b3d-49e5-b309-b35caa59dbe2
13+
https://github.com/user-attachments/assets/3fbe8eb4-0844-4df8-925a-0608e391be17
1414

1515
## What is PowerTree?
1616

@@ -29,46 +29,12 @@ From [PowerShell Gallery](https://www.powershellgallery.com/packages/PowerTree):
2929
Install-Module PowerTree
3030
```
3131

32-
## Quick Start
32+
# Commands
3333

34-
### File System Exploration
34+
## Show-PowerTree <sup><sub>Alias: `ptree`, `PowerTree`</sub></sup>
35+
A modern replacement for the tree command that lets you explore directory structures with detailed information and advanced filtering possibilities. Explore all available parameters and advanced features in the [full documentation](docs/Show-PowerTree.md).
3536

36-
```powershell
37-
# Basic usage - show tree of current directory
38-
Show-PowerTree
39-
# or use the alias
40-
ptree
41-
42-
# Show tree with sizes, sorted by size (descending)
43-
ptree -DisplaySize -SortBySize -Descending
44-
45-
# Exclude directories and filter by extension
46-
ptree -ExcludeDirectories node_modules,bin -IncludeExtensions ps1
47-
48-
# Save output to a file
49-
ptree -OutFile tree_output.txt
50-
```
51-
52-
### Registry Exploration (Windows Only)
53-
54-
```powershell
55-
# Show registry tree for a specific path
56-
Show-PowerTreeRegistry -Path "HKLM:\SOFTWARE\Microsoft"
57-
58-
# Show only registry keys (no values)
59-
Show-PowerTreeRegistry -Path "HKCU:\Software" -NoValues
60-
61-
# Display with item counts and depth limit
62-
Show-PowerTreeRegistry -Path "HKLM:\SYSTEM" -DisplayItemCounts -Depth 2
63-
```
64-
65-
# Available Commands
66-
67-
## Show-PowerTree (Alias: `ptree`, `PowerTree`)
68-
A modern replacement for the tree command that lets you explore directory structures and Windows Registry with detailed information and advanced filtering possibilities.
69-
[More Information](docs/Show-PowerTree.md)
70-
71-
### Images
37+
### Example Images
7238

7339
<details>
7440
<summary>File system with sizes sorted by size descending</summary>
@@ -114,58 +80,35 @@ ptree -DirectoryOnly -DisplaySize
11480
<img src="./images/Directory_Only.JPG" alt="PowerTree directory only view">
11581
</details>
11682

117-
### Key Features
118-
- **Display Options**: File sizes, cumulative folder sizes (with all subfolders/files), creation date, modification date, or access date and mode
119-
- **Sorting**: By name, size, creation date, modification date, or access date
120-
- **Filtering**: Include/exclude files by extension, filter on size (e.g., 1kb-20mb), show only directories, or remove empty directories
121-
- **Output Options**: Console display or export to file
122-
- **Cross-Platform**: Works on Windows, macOS, and Linux
123-
124-
### Tree Statistics
125-
PowerTree shows the following stats for your tree.
126-
127-
**Basic Statistics:**
128-
- Files and folders processed
129-
- Total items count
130-
- Maximum depth traversed
131-
- Total size of all files
132-
- Execution time
133-
134-
**When using `-DisplaySize`:**
135-
- Largest file found (size and path)
136-
- Largest folder found (size and path)
137-
138-
This feature can be disabled through `Edit-PowerTreeConfig` by setting `ShowExecutionStats` to `false`.
139-
140-
## Show-PowerTreeRegistry (Alias: `ptreer`, `PowerRegistry`) (Windows Only)
141-
Shows Windows Registry keys and values in tree format. Displays both registry keys and their values, making it easy to see the structure of any registry hive or specific key.
142-
[More Information](docs/Show-PowerTreeRegistry.md)
83+
## Show-PowerTreeRegistry <sup><sub>Alias: `ptreer`, `PowerRegistry`</sub></sup>
84+
Shows Windows Registry keys and values in tree format. Displays both registry keys and their values, making it easy to see the structure of any registry hive or specific key. Explore all available parameters and advanced features in the [full documentation](docs/Show-PowerTreeRegistry.md).
14385

144-
### Images
86+
### Example Images
14587

146-
### Key Features
147-
- **Registry Navigation**: Explore any registry hive or key with tree structure. Returns both the key and the value
148-
- **Advanced Filtering**: Include/exclude patterns for keys and values
149-
- **Output Options**: Console display or export to file
150-
151-
### Tree Statistics
152-
PowerTree shows execution statistics after each run:
153-
154-
**Basic Statistics:**
155-
- Keys and values processed
156-
- Maximum depth traversed
157-
- Execution time
158-
159-
This feature can be disabled through `Edit-PowerTreeConfig` by setting `ShowExecutionStats` to `false`.
88+
<details>
89+
<summary>Default Registry View</summary>
90+
<br>
91+
92+
```powershell
93+
PowerRegistry HKLM:\SOFTWARE\
94+
```
95+
<br>
96+
<img src="./images/Registry_Default.JPG" alt="Default PowerTree Registry View">
97+
</details>
16098

161-
## Edit-PowerTreeConfig (Alias: `Edit-PowerTree`, `Edit-ptree`)
162-
Opens the configuration file to change default settings. Set which directories to always exclude, default sorting, and tree display style.
163-
[More Information](docs/Edit-PowerTreeConfig.md)
99+
<details>
100+
<summary>Filtered Registry View</summary>
101+
<br>
102+
103+
```powershell
104+
PowerRegistry HKLM:\SOFTWARE\ -DisplayItemCounts -Exclude "*data*" -l 2 -UseRegistryDataTypes
105+
```
106+
<br>
107+
<img src="./images/Registry_Filtered.JPG" alt="Filtered PowerTree Registry View">
108+
</details>
164109

165-
### Key Features
166-
- **JSON Configuration**: Fully configurable via JSON
167-
- **Visual Customization**: Set visual custimizations not available through parameters. E.G. Tree line styles (├── vs |--), show/hide execution stats, human-readable sizes (10MB vs 10485760)
168-
- **Parameter Defaults**: Configure default exclusions (e.g., always exclude node_modules, bin, obj directories), file size limits, and depth restrictions
110+
## Edit-PowerTreeConfig <sup><sub>Alias: `Edit-PowerTree`, `Edit-ptree`</sub></sup>
111+
Opens the configuration file to change default settings. Set which directories to always exclude, default sorting, and tree display style. Explore all available parameters and advanced features in the [full documentation](docs/Edit-PowerTreeConfig.md).
169112

170113
## Common Use Cases
171114

@@ -175,11 +118,11 @@ Opens the configuration file to change default settings. Set which directories t
175118
# Find large files consuming disk space
176119
ptree -DisplaySize -SortBySize -Descending -FileSizeMinimum 100MB
177120
178-
# Explore registry configuration
179-
Show-PowerTreeRegistry -Path "HKLM:\SOFTWARE\Microsoft" -DisplayItemCounts
180-
181121
# Document directory structure for compliance
182122
ptree -DisplayAll -OutFile system_audit.txt
123+
124+
# Audit installed software and versions
125+
Show-PowerTreeRegistry -Path "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall" -Depth 2 -OutFile "output.txt"
183126
```
184127

185128
### Development Workflows

0 commit comments

Comments
 (0)