Skip to content

Commit

Permalink
Add configuration note about Docker
Browse files Browse the repository at this point in the history
Add minimal documentation for common CLI utils
  • Loading branch information
Daniel McKnight committed Dec 13, 2023
1 parent b5d303c commit 67d442b
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Configuration files can be specified via environment variables. By default,
`XDG_CONFIG_HOME` is set to the default `~/.config`.
More information about configuration handling can be found
[in the docs](https://neongeckocom.github.io/neon-docs/quick_reference/configuration/).
> *Note:* The neon-iris Docker image uses `neon.yaml` by default because the
> `iris` web UI is often deployed with neon-core.
A default configuration might look like:
```yaml
Expand All @@ -37,7 +39,17 @@ may be removed and `enable_lang_api: True` added to configuration. This will use
the reported STT/TTS supported languages in place of any `iris` configuration.

## Interfacing with a Diana installation
The `iris` CLI includes utilities for interacting with a `Diana` backend.
The `iris` CLI includes utilities for interacting with a `Diana` backend. Use
`iris --help` to get a current list of available commands.

### `iris start-listener`
This will start a local wake word recognizer and use a remote Neon
instance connected to MQ for processing audio and providing responses.

### `iris start-gradio`
This will start a local webserver and serve a Gradio UI to interact with a Neon
instance connected to MQ.

### `iris start-client`
This starts a CLI client for typing inputs and receiving responses from a Neon
instance connected via MQ.

0 comments on commit 67d442b

Please sign in to comment.