# 1.5 Command Line Tools

<section id="bkmrk-this-enhancement-is-">This enhancement is only available in KiyoCRM from version 7.11 onwards.

KiyoCRM’s Elasticsearch integration ships with two useful command-line tools powered by [*Robo*](https://robo.li/).

These two commands allow to perform indexing and searches from the command-line, making debug and integration with external tools easier.

These commands require a working connection to the database, if you are running KiyoCRM behind Docker or a VM, please execute them from a shell on the same host as the KiyoCRM web server.

## elastic:index 

The `elastic:index` command allows to run an indexing from the command-line and see the step-by-step logs. Both partial and full indexing are supported.

### Usage 

```bash
elastic:index [<differential> = 1]
```

<div class="padding highlightable sticky-parent"><div><div class="sect1"><div class="sectionbody"><div class="sect2"><div class="listingblock"><div class="content"></div></div></div><div class="sect2">  
</div></div></div></div></div>### Examples 

Running a full indexing:

<div class="padding highlightable sticky-parent"><div><div class="sect1"><div class="sectionbody"><div class="sect2"><div class="paragraph">  
</div><div class="listingblock"><div class="content"></div></div></div></div></div></div></div>```bash
vendor/bin/robo elastic:index 0
```

<div class="padding highlightable sticky-parent"><div><div class="sect1"><div class="sectionbody"><div class="sect2"><div class="listingblock"><div class="content"></div></div><div class="paragraph">  
</div></div></div></div></div></div>Running a partial indexing:

<div class="padding highlightable sticky-parent"><div><div class="sect1"><div class="sectionbody"><div class="sect2"><div class="paragraph">  
</div><div class="listingblock"><div class="content"></div></div></div></div></div></div></div>```bash
vendor/bin/robo elastic:index 1
```

<div class="padding highlightable sticky-parent"><div><div class="sect1"><div class="sectionbody"><div class="sect2"><div class="listingblock"><div class="content"></div></div><div class="paragraph">  
</div></div></div></div></div></div><span class="image">[![Elasticsearch Index CLI](https://docs.suitecrm.com/images/en/admin/ElasticSearch/ElasticIndexCLI.png)](https://docs.suitecrm.com/images/en/admin/ElasticSearch/ElasticIndexCLI.png)</span>

## elastic:search 

The `elastic:search` command allows you to perform the same kind of queries you would do from the search bar directly from the CLI. It also allows to return a JSON with additional data about the record.

### Usage 

```bash
elastic:search <query> [<size> = 20] [<showJson> = false]
```

<div class="padding highlightable sticky-parent"><div><div class="sect1"><div class="sectionbody"><div class="sect2"><div class="listingblock"><div class="content"></div></div><div class="paragraph">  
</div></div></div></div></div></div>You can use the full query syntax for `query` argument.

The `size` option specifies the number of results.

When the `showJson` option is enabled, a JSON will be returned for each result

### Examples 

Search for everything using the keyword 'Rohan':

<div class="padding highlightable sticky-parent"><div><div class="sect1"><div class="sectionbody"><div class="sect2"><div class="paragraph">  
</div><div class="listingblock"><div class="content"></div></div></div></div></div></div></div>```bash
vendor/bin/robo elastic:search "rohan"
```

<div class="padding highlightable sticky-parent"><div><div class="sect1"><div class="sectionbody"><div class="sect2"><div class="listingblock"><div class="content"></div></div><div class="paragraph">  
</div></div></div></div></div></div><span class="image">[![Elasticsearch CLI](https://docs.suitecrm.com/images/en/admin/ElasticSearch/ElasticSearchCLI.png)](https://docs.suitecrm.com/images/en/admin/ElasticSearch/ElasticSearchCLI.png)</span>

Search for the first account named 'Maxwell' and show a JSON:

<div class="padding highlightable sticky-parent"><div><div class="sect1"><div class="sectionbody"><div class="sect2"><div class="paragraph">  
</div><div class="listingblock"><div class="content"></div></div></div></div></div></div></div>```bash
vendor/bin/robo elastic:search "_type:Accounts AND named:Maxwell" 1 true
```

<div id="bkmrk-"></div></section><div id="bkmrk--1"></div>