Skip to content

Edit-PowerTreeConfig.md

Latest commit

 

History

History
109 lines (85 loc) · 4.03 KB

Edit-PowerTreeConfig.md

File metadata and controls

109 lines (85 loc) · 4.03 KB
external help file PowerTree-help.xml
Module Name PowerTree
online version https://github.com/spaansba/PowerTree
schema 2.0.0

Edit-PowerTreeConfig

SYNOPSIS

Opens the PowerTree configuration file for editing.

SYNTAX

Edit-PowerTreeConfig [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Edit-PowerTreeConfig is a utility cmdlet that manages your PowerTree and PowerTreeRegistry configuration file. It automatically locates or creates the configuration file and opens it in the appropriate editor for your operating system.

EXAMPLES

Example 1: Open configuration file

PS C:\> Edit-PowerTreeConfig

Opens the PowerTree configuration file in the default editor. If no configuration file exists, creates a new one with default settings.

NOTES

Configuration File Location:

  • Windows: $env:USERPROFILE\.PowerTree\config.json
  • macOS/Linux: $HOME/.PowerTree/config.json

Default Editor Behavior:

  • Windows: Opens with the system default application for JSON files
  • macOS: Uses the open command to launch the default editor
  • Linux: Attempts to use xdg-open, nano, vim, or vi in that order

Configuration File Structure:

{
  "FileSystem": {
    "MaxDepth": -1,
    "Files": {
      "IncludeExtensions": [],
      "ExcludeExtensions": [],
      "FileSizeMaximum": "-1kb",
      "FileSizeMinimum": "-1kb"
    },
    "Sorting": {
      "By": "Name",
      "SortFolders": false
    },
    "HumanReadableSizes": true,
    "ExcludeDirectories": []
  },
  "Registry": {
    "MaxDepth": -1,
    "DisplayValues": false,
    "ExcludeKeys": []
  },
  "Shared": {
    "LineStyle": "unicode",
    "ShowExecutionStats": true,
    "ShowConfigurations": true,
    "ShowConnectorLines": true,
    "OpenOutputFileOnFinish": true
  }
}

Configuration Options

Option Description Default Overridden By
FileSystem.MaxDepth Maximum directory depth to traverse (-1 = unlimited) -1 -Depth parameter
FileSystem.ExcludeDirectories Standard directories to always exclude [] -ExcludeDirectories parameter
FileSystem.HumanReadableSizes Show sizes as KB/MB/GB instead of raw bytes true Config file only
FileSystem.Files.IncludeExtensions Only show files with these extensions (empty = all files) [] -IncludeExtensions parameter
FileSystem.Files.ExcludeExtensions Hide files with these extensions [] -ExcludeExtensions parameter
FileSystem.Files.FileSizeMinimum Hide files smaller than this size (-1kb = no limit) "-1kb" -FileSizeMinimum parameter
FileSystem.Files.FileSizeMaximum Hide files larger than this size (-1kb = no limit) "-1kb" -FileSizeMaximum parameter
FileSystem.Sorting.By Default sort method ("Name", "Size", "Date", etc.) "Name" -Sort and -SortBy* parameters
FileSystem.Sorting.SortFolders Apply sorting to directories (false = folders first) false Config file only
Registry.MaxDepth Maximum registry depth to traverse (-1 = unlimited) -1 -Depth parameter
Registry.DisplayValues Show registry value data (can be verbose) false -DisplayValues parameter
Registry.ExcludeKeys Registry keys to always exclude [] -ExcludeKeys parameter
Shared.LineStyle Tree connector style ("unicode" for ├── or "ascii" for |--) "unicode" Config file only
Shared.ShowExecutionStats Display timing and file count statistics true Config file only
Shared.ShowConfigurations Display active configuration at start true Config file only
Shared.ShowConnectorLines Show tree connector lines true Config file only
Shared.OpenOutputFileOnFinish Automatically open output file when using -OutFile true Config file only

RELATED LINKS

PowerTree GitHub Repository

Show-PowerTree

Show-PowerTreeRegistry