Invoke Plover from the Command Line: Difference between revisions
(Created page with "Sometimes (for instance, to manually install plugins) you're required to run a command from the command-line. The method is specific for each operating systems and shells. (Powershell, Windows command shell, bash, zsh, etc.) In the example below, assume that the following command should be executed: <code>plover -s plover_plugins install plover-stenograph-usb</code> To run other commands, modify the arguments (<code>-s plover_plugins install plover-stenograph-usb</cod...") |
No edit summary |
||
| Line 1: | Line 1: | ||
Sometimes (for instance, to manually install plugins) you're required to run a command from the command-line. | Sometimes (for instance, to [[Plugins#Manually Installing Plugins|manually install plugins]]) you're required to run a command from the command-line. | ||
The method is specific for each operating systems and shells. (Powershell, Windows command shell, bash, zsh, etc.) | The method is specific for each operating systems and shells. (Powershell, Windows command shell, bash, zsh, etc.) | ||
| Line 7: | Line 7: | ||
To run other commands, modify the arguments (<code>-s plover_plugins install plover-stenograph-usb</code>) accordingly. | To run other commands, modify the arguments (<code>-s plover_plugins install plover-stenograph-usb</code>) accordingly. | ||
See also Command Line Reference | See also [https://plover.readthedocs.io/en/latest/cli_reference.html Command Line Reference]<sup>[external link]</sup> for other commands that can be executed. | ||
== Windows == | == Windows == | ||
# Find Plover's installation directory. It usually is in the format <code>C:\Program Files (x86)\Open Steno Project\Plover 4.0.0</code>. | # Find Plover's installation directory. It usually is in the format <code>C:\Program Files (x86)\Open Steno Project\Plover 4.0.0</code>. You can find it by right-clicking a shortcut to Plover and selecting "Open File Location" | ||
[[File:Windows plover shortcut right click menu.png|frameless|623x623px]] | |||
# You should see <code>plover.exe</code> and <code>plover_console.exe</code> in this folder. '''Holding shift''', right-click and select "Open PowerShell Window Here" or "Open Command Prompt Window Here." | # You should see <code>plover.exe</code> and <code>plover_console.exe</code> in this folder. '''Holding shift''', right-click and select "Open PowerShell Window Here" or "Open Command Prompt Window Here." | ||
[[File:Shift right click menu on plover console.png|frameless|617x617px]] | |||
# Type in the following command: | # Type in the following command: | ||
.\plover_console.exe -s plover_plugins install plover-stenograph-usb | |||
[[File:Showing full path of command in powershell.png|left|frameless|1293x1293px]] | |||
# | |||
# Press Enter to run the command. | # Press Enter to run the command. | ||
[[File:Install plugin output in powershell.png|frameless|675x675px]] | |||
== Mac == | == Mac == | ||
| Line 20: | Line 27: | ||
# Open the Terminal app | # Open the Terminal app | ||
# Assuming Plover in installed in your Applications folder, enter this into Terminal and hit enter: | # Assuming Plover in installed in your Applications folder, enter this into Terminal and hit enter: | ||
/Applications/Plover.app/Contents/MacOS/Plover -s plover_plugins install plover-stenograph-usb | |||
== Linux (AppImage) == | |||
# Execute the command in the command-line: | |||
plover.AppImage -s plover_plugins install plover-stenograph-usb | |||
Revision as of 20:26, 12 February 2024
Sometimes (for instance, to manually install plugins) you're required to run a command from the command-line.
The method is specific for each operating systems and shells. (Powershell, Windows command shell, bash, zsh, etc.)
In the example below, assume that the following command should be executed:
plover -s plover_plugins install plover-stenograph-usb
To run other commands, modify the arguments (-s plover_plugins install plover-stenograph-usb) accordingly.
See also Command Line Reference[external link] for other commands that can be executed.
Windows
- Find Plover's installation directory. It usually is in the format
C:\Program Files (x86)\Open Steno Project\Plover 4.0.0. You can find it by right-clicking a shortcut to Plover and selecting "Open File Location"
- You should see
plover.exeandplover_console.exein this folder. Holding shift, right-click and select "Open PowerShell Window Here" or "Open Command Prompt Window Here."
- Type in the following command:
.\plover_console.exe -s plover_plugins install plover-stenograph-usb
- Press Enter to run the command.
Mac
- Open the Terminal app
- Assuming Plover in installed in your Applications folder, enter this into Terminal and hit enter:
/Applications/Plover.app/Contents/MacOS/Plover -s plover_plugins install plover-stenograph-usb
Linux (AppImage)
- Execute the command in the command-line:
plover.AppImage -s plover_plugins install plover-stenograph-usb