https://github.com/omniomi/AdvancedHistory

Keyboard navigable history for Windows PowerShell and PowerShell Core.
https://github.com/omniomi/AdvancedHistory

Last synced: 9 days ago
JSON representation

Keyboard navigable history for Windows PowerShell and PowerShell Core.

• Host: GitHub
• URL: https://github.com/omniomi/AdvancedHistory
• Owner: omniomi
• License: mit
• Created: 2018-06-02T22:47:34.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-06-03T03:50:55.000Z (over 6 years ago)
• Last Synced: 2024-08-01T13:37:02.139Z (3 months ago)
• Language: PowerShell
• Size: 374 KB
• Stars: 20
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![Build status](https://ci.appveyor.com/api/projects/status/github/omniomi/advancedhistory?branch=master&svg=true)](https://ci.appveyor.com/project/omniomi/advancedhistory/branch/master)

# AdvancedHistory

Add keyboard navigable and filterable history to Windows PowerShell and PowerShell Core. Once an item is selected the menu is cleared from the console but your buffer is not erased meaning you can still scroll up and view previously executed commands.

![Screenshot](images/screenshot.png)

This is an adaptation of an [example by Jeff Hicks on Petri.com](https://www.petri.com/more-efficient-powershell-with-psreadline) where he used the PSReadline History with `Out-GridView` to make selectable history. I liked the idea but wanted something that wouldn't take me out of the console. This is an early pass taking what I had in my profile and adapting it in to a module to make it easier to share but a number of improvements are planned.

## Setup

### Installation

#### Install from PSGallery

```PowerShell

Install-Module AdvancedHistory -Scope CurrentUser

```

#### Install from Source

```PowerShell

git clone https://github.com/omniomi/AdvancedHistory.git

cd .\AdvancedHistory\tools

.\Build.ps1 Install

```

### Enable AdvancedHistory

The easiest way to ensure that AdvancedHistory is always available is to add it to your [$PROFILE](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_profiles?view=powershell-5.0). Simply add these two lines anywhere in your PowerShell profile:

```PowerShell

Import-Module AdvancedHistory

Enable-AdvancedHistory

```

### Setting the Keyboard Shortcut

By default AdvancedHistory uses F7 for accessing the history menu. To change the shortcut specify the key or keys as a string following `Enable-AdvancedHistory`. For example, to use Ctrl+F7 you would use `Enable-AdvancedHistory 'Ctrl+F7'`

### Only Show Unique Command History

To only show unique commands from your history once (most recent execution) use the `-Unique` switch on `Enable-AdvancedHistory`.

### Override History Limit

By default the AdvancedHistory will limit the menu to 256 items whether unique or not. To override the limit set `$Global:HistoryCountOverride = ` either in your PowerShell Profile or at the CLI as needed. For example, `$Global:HistoryCountOverride = 512`

> NOTE: The history override must come before `Enable-AdvancedHistory`.

> ```PowerShell

> # $Profile

> Import-Module AdvancedHistory

> $Global:HistoryCountOverride = 512

> Enable-AdvancedHistory

> ```

## Usage

To access the AdvancedHistory menu press either F7 or the keyboard shortcut you specified when setting it up.

### Navigation

* Up/Down Arrows: Navigate the list

* Right/Left Arrows: Change the page

* Enter/Return: Select the highlighted line item

* Esc: Cancel

### Filtering

To filter the search type any part of the command at the prompt before pressing the activation key.

```PowerShell

C:\> mkdir MyProject

C:\> cd .\MyProject\

C:\MyProject\> MyProj

Select a Command (it will be inserted at the prompt but not executed)

  cd .\MyProject\

  mkdir MyProject

 Page: 1 / 1

```

## Requirements

- Requires PSReadline (included in PowerShell >=5.0)