Invoke plover from the command line: Difference between revisions

From Plover Wiki
(First pass at creating page based on markdown to mediawiki wtih pandoc. Still needs images and captions into mediawiki format.)
 
(Remove converted page and redirect to correct page)
Tag: New redirect
 
Line 1: Line 1:
Sometimes (for instance, to [https://github.com/openstenoproject/plover/wiki/Installing-Plugins#manually-installing-plugins manually install plugins]) you're required to run a command from the command-line.
#REDIRECT [[Invoke_Plover_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:
 
<pre>plover -s plover_plugins install plover-stenograph-usb</pre>
To run other commands, modify the arguments (<code>-s plover_plugins install plover-stenograph-usb</code>) accordingly.
 
See also [https://plover.readthedocs.io/en/latest/cli_reference.html Command Line Reference - Plover 4.0.0-dev10<sup>[external link]</sup>] for other commands that can be executed.
 
== Compatible Versions ==
 
Ensure you are running Plover 4.x.
 
== Windows ==
 
<ol style="list-style-type: decimal;">
<li><p>Find Plover's installation directory. It usually is in the format <code>C:\Program Files (x86)\Open Steno Project\Plover 4.0.0</code>.</p>
<p>You can find it by right-clicking a shortcut to Plover and selecting "Open File Location"</p>
 
Right-clicking shortcut to show Open File Location option: https://i.imgur.com/jsXQZA4.png
<li><p>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."</p>
[[File:https://i.imgur.com/vJAC3tE.png|Open Powershell option highlighted]]</li>
<li><p>Type in the following command:</p>
<pre>.\plover_console.exe -s plover_plugins install plover-stenograph-usb</pre>
caption Command above in Powershell:
https://i.imgur.com/3AG4zfA.png
</li>
<li><p>Press Enter to run the command.</p>
Successful install screenshot with message highlighted:
https://i.imgur.com/GfawoX3.png
</li></ol>
 
== Mac ==
 
<ol style="list-style-type: decimal;">
<li>Open the Terminal app</li>
<li><p>Assuming Plover in installed in your Applications folder, enter this into Terminal and hit enter:</p>
<pre>/Applications/Plover.app/Contents/MacOS/Plover -s plover_plugins install plover-stenograph-usb</pre></li></ol>
 
== Linux (AppImage) ==
 
<ol style="list-style-type: decimal;">
<li><p>Execute the command in the command-line:</p>
<pre>plover.AppImage -s plover_plugins install plover-stenograph-usb</pre></li></ol>

Latest revision as of 15:16, 29 August 2024