diff --git a/PoshPredictiveText/AdditionalFiles/PoshPredictiveText.psd1 b/PoshPredictiveText/AdditionalFiles/PoshPredictiveText.psd1 index 462b625..79b61ef 100644 --- a/PoshPredictiveText/AdditionalFiles/PoshPredictiveText.psd1 +++ b/PoshPredictiveText/AdditionalFiles/PoshPredictiveText.psd1 @@ -33,7 +33,8 @@ # Description of the functionality provided by this module Description = @" PowerShell argument completer for popular command line tools. Supports -both tab-expansion and PSReadLine plugin. +both tab-expansion and worls as a PSReadLine plugin providing suggestions +in the drop-down list. # Supported Command Line Tools @@ -61,6 +62,14 @@ The first command needed to remove the tab-expansion code automatically and sile by conda. The conda code prevents Posh Predictive Text from providing completions. The second command installs Posh Predictive Text. +Completions will appear when a partial argument is entered and the tab key is pressed. A longer +list of options with tooltips is available by pressing ctrl-space. + +It is recommended to add the following PSReadLine options in the PowerShell profile so that +suggestions appear below the command line as command arguments are entered. + +Set-PSReadLineOption -PredictionSource HistoryAndPlugin -PredictionVewStyle ListView + # Further information Additional settings are described on the project website. diff --git a/README.md b/README.md index 463170e..707af1b 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,14 @@ Most people will be familiar with predictive text on mobile phones. Posh-predict brings the same capability to the PowerShell command line interface for common CLI tools used within the software development and data science community. +PoshPredictiveText provides suggested completions: + +- When a partial argument is entered and the `tab` key is pressed. Successive suggestion +appear each time the `tab` key is pressed. +- Pressing `ctrl` + `space` display a popup list of options with tooltips. +- If PSReadLine options `-PredictionSource` is set to use the plugin and `-PredictionViewStyle` +is set to `ListView` then suggestions will appear below the command line. + ## Supported Command Line Tools Predictive text is available for the following commands line tools. @@ -69,6 +77,16 @@ The first command removes tab-expansion that is already installed by conda, and Posh Predictive Text from providing completions. The second command installs Posh Predictive Text. +Completions will appear when a partial argument is entered and the tab key is pressed. A longer +list of options with tooltips is available by pressing ctrl-space. + +It is recommended to add the following PSReadLine options in the PowerShell profile so that +suggestions appear below the command line as command arguments are entered. + +```powershell +Set-PSReadLineOption -PredictionSource HistoryAndPlugin -PredictionVewStyle ListView +``` + ## Contributing Contributions to the project are welcome. No developer is an island, there is never enough time