Skip to content

Helpers

Nate Ferrell edited this page Aug 22, 2019 · 14 revisions

SHORT DESCRIPTION

An overview of the Helper functions in PSProfile.

LONG DESCRIPTION

PSProfile Helpers are functions that enable easier integration with PSProfile.

These include functions to make prompt customization easier as well as functions for Plugin developers to leverage to perform tasks like adding to the PSProfile log with Write-PSProfileLog or provide argument completers with Get-PSProfileArguments .

COMMANDS

Gets the duration last command as a timestamp string for use in prompts.

Gets the shortened Path Alias for use in prompts.

Gets argument completers from PSProfile, e.g. the list of prompt names for prompt management functions.

Gets the PSVersion as an easy to read string, including the ability to specify the number of decimal places to limit the resulting version string to.

Tests if the current path is a Git repo folder and returns contextual information about it if so. Useful for prompts.

Writes a PSProfileEvent to the $PSProfile.Log . Useful for custom plugins so that logging remains lightweight and centralized.

PSProfile

Concepts

Function Help

Command Aliases

Configuration

Helpers

Init Scripts

Meta

Modules to Import

Modules to Install

Path Aliases

Plugin Paths

Plugins

Power Tools

Project Paths

Prompts

Script Paths

Secrets

Symbolic Links

Variables

Badges

Azure Pipelines      Discord - Chat      Slack - Chat      Codacy PowerShell Gallery      GitHub Releases      GitHub Releases

Clone this wiki locally