Command Line Interface

* Introduction

  For application maintenance.
  
* Glossary

  <<<neeo-config add-partner --partner-id \<id\> --configuration-url \<url\>>>>\
  <<<neeo-config fetch-partner --partner-id \<id\>>>>\
  <<<neeo-config list-partners>>>
  
* General

  <<<neeo-config \<command\> \[--<parameter> <value> \[--<parameter> <value> \[...\]\]\]>>>
  
  Parameters can be entered with long and short options and with or without '='.
  The following commands are equal:\
  <<<neeo-config fetch-partner --partner-id=uvt>>>\
  <<<neeo-config fetch-partner --partner-id uvt>>>\
  <<<neeo-config fetch-partner -p=uvt>>>\
  <<<neeo-config fetch-partner -p uvt>>>
  
  List of parameters:
  
  <<<--partner-id | -p>>>\
  The id of a partner.
  
  <<<--configuration-url | -u>>>\
  The url of the configuration document for a partner.
  
  <<<--query | -q>>>\
  A query.
  
  <<<--page | -n>>>\
  Page number.
  

* Commands (listed in alfabetical order)

** <<<activate-partner --partner-id \<id\>>>> (under development)

  Activates a valid partner.
  The status changes from <<<valid>>> to <<<active>>>.
  An active partner is visible in the NEEO website.
  The partner must have status <<<valid>>> before this command is issued, otherwise an error message is printed.
  
** <<<add-partner --partner-id \<id\> --configuration-url \<url\>>>>

  Adds a new partner to the list of partners. The status of this partner will be <<<new>>>.
  If a partner with this <<<id>>> already exists, an error message will be printed and the existing partner configuration will not be overwritten.
  
** <<<delete-partner --partner-id \<id\>>>> (under development)

  Changes the status into <<<deleted>>>.
  No data is deleted.
  To delete the partner completely, remove the directory with partner data.
  
** <<<fetch-configuration --partner-id \<id\>>>>

  Fetches the XML document from <<<configuration-url>>>, validates the content of the fetched document and replaces file <<<configuration.xml>>> with the fetched document if it is valid.
  A <<<valid>>> or <<<active>>> status never changes because of this command, even if the fetched document is invalid.
  An <<<new>>> status changes to <<<valid>>> if the fetched document is valid.
  The command is not allowed on partners with status <<<deleted>>>.

** <<<inactivate-partner --partner-id \<id\>>>> (under development)

  Inactivates a partner.
  The status changes from <<<active>>> to <<<valid>>>.
  An inactive partner is not visible anymore in the NEEO website.
  The partner must have status <<<active>>> before this command is issued, otherwise an error message is printed.
  
** <<<list-partners>>>

  Prints a list of partners, including their statusses.

** <<<search --query \<query\> [--page \<nr\>]>>>

  Search the SRU server.

** <<<show-partner --partner-id \<id\>>>> (under development)

  Prints information about a specific partner.

** <<<test-partner --partner-id \<id\>>>> (under development)

  Performs a number of tests on the <<<configuration.xml>>> document.
  This doesn't change the status of the partner.
  It can be used by administrators before activating a partner or in case of problems.