Skip to content

Latest commit

 

History

History
72 lines (47 loc) · 2.87 KB

Readme.en-UK.md

File metadata and controls

72 lines (47 loc) · 2.87 KB

fount-pwsh

PSGallery download num

fount-pwsh is a tool that allows you to easily use Fount in PowerShell (pwsh) or esh terminals. It can help you use your shell better, or just chat with roles in the shell.

Image: fount-pwsh usage example

Installation

Use this command to install the fount-pwsh module:

Install-Module fount-pwsh

Note: fount-pwsh relies on Fount to work. But don't worry! If you haven't installed Fount yet, fount-pwsh will automatically install Fount for you the first time you use the following commands:

  • Start-Fount
  • Set-FountAssist
  • Install-FountAssist

Configure Assistant

You need a Fount role that supports the shellassist interface.

Warning

About PowerShell performance

In PowerShell, loading a Fount assistant takes about 600 milliseconds on average. This may slightly affect your shell startup speed. (For esh, loading is instantaneous.)

If you want PowerShell to start faster, you can consider setting the loading of the Fount assistant to background loading (refer to PowerShell's event registration and OnIdle event).

Two ways to enable your assistant:

1. Automatic Configuration (Recommended):

Use this command to have the Fount assistant automatically start and provide assistance each time you open a new shell window:

Install-FountAssist <Your Fount Username> <Required Role Name>

Replace <Your Fount Username> and <Required Role Name> with your actual Fount username and role name.

2. Manual Configuration (For Advanced Users):

If you want to set it up manually, you can add the following code to your shell profile file:

Set-FountAssist <Your Fount Username> <Required Role Name>

When does the assistant appear?

The Fount assistant will automatically appear in the following situations:

  • When you enter an incorrect command (such as a spelling error).
  • When a command you run fails to execute (the value of $? is false).
  • When you actively use the f command

Disable/Enable Automatic Assistant

You can use the f command to easily disable or enable the automatic assistant feature:

f 0    # Disable automatic assistant (also possible with f false / f no / f n / f disable / f unset / f off etc.)
f 1    # Enable automatic assistant (also possible with f true / f yes / f y / f enable / f set / f on etc.)