From 290c409e5df026740f692b44067380c88b51613f Mon Sep 17 00:00:00 2001 From: Mike Date: Fri, 15 Mar 2024 19:25:15 -0500 Subject: [PATCH] feat(docs): ovos-bus-client scripts (#87) --- docs/032-qs_next_steps.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/docs/032-qs_next_steps.md b/docs/032-qs_next_steps.md index b711233a..17e7423e 100644 --- a/docs/032-qs_next_steps.md +++ b/docs/032-qs_next_steps.md @@ -43,3 +43,34 @@ PHAL plugins allow OVOS to interact with the underlying hardware and operating s OVOS ships with default services available to the public to use. These include public TTS and STT servers, a weather API provided by [OpenMeteo](https://openmeteo.com/), access to Wolfram, and more. Since OVOS is an open and private system, you can also change these to your own preferences. [Install your own Services](999-not-implemented) **WIP** + +## Interacting by command line + +While OVOS is primarily a voice-driven platform, sometimes it makes sense to interact by CLI for troubleshooting, testing, or development. OVOS ships several tools with [ovos-bus-client](https://github.com/OpenVoiceOS/ovos-bus-client) in most distros. + +### ovos-listen + +Typing the command `ovos-listen` will make the listener service start listening for voice commands. If you haven't set up a wakeword or you're having issues with your wakeword, this can be a good way to check if the entire listener is not working. + +### ovos-speak + +The `ovos-speak` command will tell the assistant to speak whatever you type after it. This command can be useful for demonstrations or to play pranks on nearby family members or roommates. For example: + +```bash +$ ovos-speak "Look ma, no data shared with big companies!" +``` + +Note the quotes - you must include the quotes, otherwise the assistant would only say "look." + +### ovos-say-to + +The `ovos-say-to` command will send an utterance to the assistant, to be processed normally by the assistant. It effectively skips the speech-to-text portion of the interaction. This command is useful in situations where you can't or don't want to speak to the assistant - for example, when roommates or family members are sleeping, or you're already typing to test new skill code. + +Example: + +```bash +$ ovos-say-to "What time is it?" +``` + +Again, note the quotes. Without quotes only the first word will be sent to the assistant, which will typically result in an error. +