Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
DiaAzul committed Sep 16, 2022
1 parent 0677e8a commit b9de388
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
11 changes: 10 additions & 1 deletion PoshPredictiveText/AdditionalFiles/PoshPredictiveText.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit b9de388

Please sign in to comment.