Note

You can skip this section if you are using the supplied Docker image with the entire Persephone software stack.

Follow the steps below to install PersephoneShell on your operating system.

Windows

To install PersephoneShell on a Windows machines, just unpack the provided ZIP archive to any directory. The application can be started by running a command 'psh.exe' with parameters. Note, that before actually using PersephoneShell, you will need to make changes to psh.exe.config configuration file (next topic).

 A typical command to start PersephoneShell would be:

psh -s dev

where dev is the name of the connection string specified inside the configuration file.

Mac OS X and Linux

To install PersephoneShell on Linux or Mac OS X machines, follow the steps below.

Make sure that the Mono framework of version 6.8 or higher is pre-installed.

1. Extract the archive to a folder (e.g., /usr/local).
2. Give execute permission to the psh script.
3. Edit the file psh.exe.config (see next topic).
4. The application can be started by running 'mono psh.exe -s <connectonName>' with parameters or by running the one-line psh script with parameters.

The text of the script psh normally includes the call to the wrapper mono (that allows running .NET binary executables on other OS) and the database connection name (e.g., dev) and "$@", which passes the commands to PersephoneShell:

mono psh.exe -s dev $@

 A typical command using  psh to start PersephoneShell would be just:

./psh

Running a PersephoneShell command and exiting back to the OS prompt is done by passing the command to the script:

./psh list mapset -l