Invoke Plover from the Command Line: Difference between revisions

From Plover Wiki
No edit summary
No edit summary
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__TOC__
Sometimes (for instance, to [[Plugins#Manually Installing Plugins|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.


Line 4: Line 6:


In the example below, assume that the following command should be executed:
In the example below, assume that the following command should be executed:
  <code>plover -s plover_plugins install plover-stenograph-usb</code>
  plover -s plover_plugins install plover-stenograph
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</code>) accordingly.


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.
See also [https://plover.readthedocs.io/en/latest/cli_reference.html Command Line Reference] for other commands that can be executed.


== Windows ==
== Windows ==
Line 17: Line 19:


# Type in the following command:
# Type in the following command:
  .\plover_console.exe -s plover_plugins install plover-stenograph-usb
  .\plover_console.exe -s plover_plugins install plover-stenograph
[[File:Showing full path of command in powershell.png|left|frameless|1293x1293px]]
[[File:Showing full path of command in powershell.png|left|frameless|1293x1293px]]
#
#
Line 27: Line 29:
# 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
  /Applications/Plover.app/Contents/MacOS/Plover -s plover_plugins install plover-stenograph


== Linux (AppImage) ==
== Linux (AppImage) ==


# Execute the command in the command-line:
# Navigate to the folder containing the AppImage
# Execute the command in the command-line (note that the filename depends on the version):


  plover.AppImage -s plover_plugins install plover-stenograph-usb
  ./plover.AppImage -s plover_plugins install plover-stenograph

Latest revision as of 03:55, 17 June 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

To run other commands, modify the arguments (-s plover_plugins install plover-stenograph) accordingly.

See also Command Line Reference for other commands that can be executed.

Windows

  1. 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"

  1. You should see plover.exe and plover_console.exe in this folder. Holding shift, right-click and select "Open PowerShell Window Here" or "Open Command Prompt Window Here."

  1. Type in the following command:
.\plover_console.exe -s plover_plugins install plover-stenograph
  1. Press Enter to run the command.

Mac

  1. Open the Terminal app
  2. 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

Linux (AppImage)

  1. Navigate to the folder containing the AppImage
  2. Execute the command in the command-line (note that the filename depends on the version):
./plover.AppImage -s plover_plugins install plover-stenograph