Interactive versus Command Line Mode

PersephoneShell is executed either in a command line mode (also known as "batch mode") or in an interactive mode. The command line mode executes a single command at a time. It is useful when you use it along with a shell script. To execute a single command, specify the required command and arguments with a valid connection string. It returns 0 for normal termination and 1 for any error.

psh <command> <target> [OPTIONS] -s {CONNECTION_STRING|CONNECTION_STRING_NAME}

The following screenshot shows an example.

Single Command Example

Alternatively, the interactive mode allows you to test out and see what PersephoneShell does. The default shell prompt PS> indicates that you are in interactive mode. To start in interactive mode, execute PersephoneShell with a valid connection string.

psh -s {CONNECTION_STRING|CONNECTION_STRING_NAME}
Persephone Shell 0.5
Copyright (C) 2014-2018 Ceres, Inc.
PS> <command> <target> <id> [OPTIONS]

The following screenshot shows a valid example of entering interactive mode and executing a command.

PersephoneShell Interactive Mode

Tip

In interactive mode use the up and down arrows on your keyboard to scroll through your command history.

Displaying the Help Menu

To list supported commands, use the help command:

PS> help

  add         Add source(s) to the Persephone database.
  clear       Clear the PersephoneShell workspace.
  convert     Convert a file to a supported file format.
  delete      Delete an object from the Persephone database.
  detail      Provide with details about an object.
  edit        Edit selected object.
  export      Export target to file from the Persephone database.
  history     Display the history list.
  init        Initialize the Persephone database.
  list        list an object in the Persephone database.
  select      Select a Persephone object.
  deselect    Empty the current object.
  update      Update data in DB.
  quit        Quit the PersephoneShell.
  help        Display more information on a specific command.


Running PersephoneShell on Mac OS and Linux Computers

You can run PersephoneShell on Linux or Mac OS X computers by installing the Mono framework. Click the appropriate link below to learn more about the Mono framework and how to install it on your machine.

Mono framework runs any executable file (*.exe) compiled in the .NET/Mono framework as shown below.

mono psh.exe -s {CONNECTION_STRING|CONNECTION_STRING_NAME}