# Kalliope Command-line interface

- [Kalliope Command-line interface](#kalliope-command-line-interface)
    - [SYNOPSIS](#synopsis)
    - [ARGUMENTS](#arguments)
        - [start](#start)
        - [gui](#gui)
        - [install](#install)
    - [OPTIONS](#options)
        - [-v or --version](#v-or---version)
        - [--run-synapse SYNAPSE_NAME](#run-synapse-synapsename)
        - [--run-order "Your Order"](#run-order-your-order)
        - [--brain-file BRAIN_FILE](#brain-file-brainfile)
        - [--deaf](#deaf)
        - [--debug](#debug)
        - [--git-url](#git-url)

## SYNOPSIS
This is the syntax used to run Kalliope from command line
```bash
kalliope command --option <argument>
```

For example, to start Kalliope we simply use
```bash
kalliope start
```

> **Note:** Do not use the CLI as root user or with sudo. Kalliope must run with standard user privileges.

## ARGUMENTS

### start
Start Kalliope main program

Example of use
```bash
kalliope start
```

To kill Kalliope, you can press "Ctrl-C" on your keyboard.

### gui
Launch the Kalliope shell Graphical User Interface.
The GUI allows you to test your [STT](stt.md) and [TTS](tts.md) that you have configured in [settings.yml](default_settings.md) file of Kalliope.

Example of use
```bash
kalliope gui
```

### install
Install a community module. You must set an install type option. Currently the only available option is `--git-url`.

Syntax
```bash
kalliope install --git-url <url>
```

Example of use
```bash
kalliope install --git-url https://github.com/kalliope-project/kalliope_neuron_wikipedia.git
```

## OPTIONS

Commands can be completed by the following options:

### -v or --version
Display the current isntalled version of Kalliope.

Example of use
```bash
kalliope --version
```

```bash
kalliope -v
```

### --run-synapse SYNAPSE_NAME

Run a specific synapse from the brain file.

Example of use
```bash
kalliope start --run-synapse "say-hello"
```

### --run-order "Your Order"

Run a specific order from command line.

Example of use
```bash
kalliope start --run-order "hello"
```

### --brain-file BRAIN_FILE

Replace the default brain file from the root of the project folder by a custom one.
> **Important note:** The path must be absolute. The absolute path contains the root directory and all other subdirectories in which a file or folder is contained.

Example of use
```bash
kalliope start --brain-file /home/me/my_other_brain.yml
```

You can combine the options together like, for example:
```bash
kalliope start --run-synapse "say-hello" --brain-file /home/me/my_other_brain.yml
```

### --deaf

Starts Kalliope in a deaf state, the trigger is paused.

Example of use
```bash
kalliope start --deaf
```

You can combine the options together like, for example:
```bash
kalliope start --deaf --brain-file /home/me/my_other_brain.yml
```

### --debug

Show debug output in the console

Example of use
```bash
kalliope start --debug
```

### --git-url

Used by the `install` argument to specify the URL of a git repository of the module to install.