From cce83d0279bcbc83aea627ca4b311d5183e4c909 Mon Sep 17 00:00:00 2001 From: Daniel McKnight <34697904+NeonDaniel@users.noreply.github.com> Date: Wed, 13 Dec 2023 11:41:40 -0800 Subject: [PATCH] Update Documentation and Logging (#48) * Add configuration note about Docker Add minimal documentation for common CLI utils * Log warning for manually-specified config path --------- Co-authored-by: Daniel McKnight --- README.md | 14 +++++++++++++- neon_iris/cli.py | 3 +++ 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 07a022f..16a537e 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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. diff --git a/neon_iris/cli.py b/neon_iris/cli.py index 582ab83..2539846 100644 --- a/neon_iris/cli.py +++ b/neon_iris/cli.py @@ -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