Skip to content

Commit

Permalink
Update Documentation and Logging (#48)
Browse files Browse the repository at this point in the history
* Add configuration note about Docker
Add minimal documentation for common CLI utils

* Log warning for manually-specified config path

---------

Co-authored-by: Daniel McKnight <[email protected]>
  • Loading branch information
NeonDaniel and NeonDaniel authored Dec 13, 2023
1 parent b5d303c commit cce83d0
Show file tree
Hide file tree
Showing 2 changed files with 16 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.
3 changes: 3 additions & 0 deletions neon_iris/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,9 @@ def start_client(mq_config, user_config, lang, audio):
from neon_iris.client import CLIClient
_print_config()
if mq_config:
from ovos_config.locations import find_user_config
click.echo(f"WARNING: Configuration should me moved to: "
f"{find_user_config()}.")
mq_config = load_config_file(expanduser(mq_config))
else:
from ovos_config.config import Configuration
Expand Down

0 comments on commit cce83d0

Please sign in to comment.