PSEdit

Edit PowerShell scripts & JSON/YAML files directly in your terminal.

Installation

This module is available on the PowerShell Gallery.

Install-Module psedit

Editing

To start the editor, you can simply call Show-PSEditor in a terminal.

Show-PSEditor

You can open a file by using the -Path parameter.

Show-PSEditor -Path .\file.path

You can also use the psedit alias.

psedit

Features

• IntelliSense
• Syntax Higlighting
• Format on Save
• Script Execution
• Error View
• Syntax Error View

Language support

Language	IntelliSense	Syntax Highlighting	Formatting	Run Code
PowerShell	✔	✔	✔*	✔
JSON	✖️	✔	✔
YAML	✖️	✔	✔

All other text based files are supported, and will be treated as plain text files.

(* Requires PSScriptAnalyzer to be installed)

You can only format your PowerShell code in the editor if you have PSScriptAnalyzer installed. To format a script, either press Ctrl+Shift+R or click Edit \ Format. If you don't have PSScriptAnalyzer installed, you can do so with the command below.

Install-Module PSScriptAnalyzer

Syntax Errors

Syntax errors will be shown in the editor by a red highlight. To view the text of the syntax error, click View \ Syntax Errors.

Theme Support

PSEdit supports customizable themes via a psedit.json file in My Documents folder, or in the working directory.

You can also provide a ConfigurationFile parameter to psedit to specify a custom location for the theme file.

psedit -ConfigurationFile ".\mytheme.json"

If the file is not present, a default theme is used. The theme file allows you to override editor colors for backgrounds, text, errors, and more.

Example psedit.json

{
	"Theme": {
		"Colors": {
			"Background": "Black",
			"Foreground": "White",
			"Accent": "Cyan",
			"Error": "Red",
			"Warning": "Yellow",
			"Info": "Blue",
			"String": "Brown",
			"Comment": "Green",
			"Secondary": "Gray"
		}
	}
}

If a color key is missing, the default value will be used. Changes to the theme file are loaded automatically when the editor starts.

Running code

To execute your script, press F5 to run the entire script. If you want to execute a select, you can press F8. You can also execute the script in the terminal and exit the editor by pressing Ctrl+Shift+F5.

You can also use the Debug menu to access these options.

Errors

Errors generated when running scripts will be shown in the error window. You can access it by clicking View \ Errors.

Ironman Software Free Tools

For more free tools, visit the Ironman Software free tools index.