====== limefu ======

//limefu// is a command line tool that helps you with various administrative tasks.

<WRAP center round info>
All commands are executed by the user running the command tool. You need to ensure that your user have the correct rights to the SQL server in order to be able to manage your database.
</WRAP>


<WRAP center round info>
All commands in the examples below are for the currently latest Lime CRM Server version. 
For older versions, always check out the built-in help in the limefu commands.
</WRAP>
===== Running limefu =====
1. Open a Lime CRM Command Prompt by double-clicking the shortcut placed on the desktop when installing Lime CRM Server. If you can't find the shortcut, open a regular command prompt as administrator and enter:

<code dos>
cd c:\Program Files (x86)\Lundalogik
procmd.bat
</code>

2. You can now run limefu. For example, to display the built-in help information:
<code dos>
(lime) C:\Program Files (x86)\Lundalogik>limefu --help
usage: limefu [-h] [-nc]
              {checksum,user,document,run,test,init,wheels,database,importer,search,view}
              ...

positional arguments:
  {checksum,user,document,run,test,init,wheels,database,importer,search,view}

optional arguments:
  -h, --help            show this help message and exit
  -nc, --no-color       Disables colored terminal output (default: False)
</code>

==== Getting help ====
limefu lets you issue different categories of commands. These are listed if you start limefu without arguments, or by adding %%--%%help.

You can ask for help for each of the category by adding ''%%--%%help or -h'' to it. The example below shows the help-section for database-category:
<code dos>
(lime) C:\Program Files (x86)\Lundalogik>limefu database --help
usage: limefu database [-h]
                       {new,list,delete,unregister,upgrade,register,diagnostics}

                       ...

Manage LIME databases

positional arguments:
  {new,list,delete,unregister,upgrade,register,diagnostics}
    new                 Create a new application in LIME and a corresponding
                        SQL database.
    list                List registered databases.
    delete              Delete a application and the corresponding SQL
                        database
    unregister          Unregister a application. Does not remove the database
                        from the SQL server
    upgrade             Upgrades an existing database
    register            Register an existing databas with Lime CRM.
    diagnostics         Diagnose LIME database health

optional arguments:
  -h, --help            show this help message and exit
</code>

===== Commands =====
==== Registering a database ====
In the following example, a SQL Server database named //limedb// located at //sqlserver01// will be registered using the display name "Acme Inc. CRM":

<code>
limefu database register --sql-server sqlserver01 --sql-database limedb --application "Acme Inc. CRM" --admin-password "supersecretpassword"
</code>

===== How to:=====
==== Update an index for a specific limetype ====
If you want to update one or multiple specific indexes, do as follows. To be clear: this will give you a clean index with only the specified type(s) generated.

1. First you need to create an index with command: <code>limefu search create-index -a <application name></code> This will create an empty index for you. The name of the recently created index will be promped to you when the creation is done. This name will be used in the next step.

2. Now we need to update the created index for a specific limetype. This we do by the command: <code>limefu search update-index -a <application name> -x <the name of the recently created index> -t <what limetype that should be indexed (if multiple, just write them comma separated)></code>

3. Lastly we need to activate the new index with the command: <code>limefu search activate-index -a <app name> -x <the index name></code>


Now you have an index with specific types generated.