2022-02-08 12:40:22 -06:00
|
|
|
# mycroft-run-script
|
|
|
|
|
|
2022-02-08 16:37:13 -06:00
|
|
|
A [Mycroft.ai](https://mycroft.ai) skill to run an arbitrary shell script.
|
|
|
|
|
|
2022-06-30 17:07:38 -05:00
|
|
|
## Install
|
|
|
|
|
|
|
|
|
|
This skill isn't in the official marketplace (for now) so the best way to install it is via the command line:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
mycroft-msm install https://code.sitosis.com/rudism/mycroft-run-script
|
|
|
|
|
```
|
|
|
|
|
|
2022-02-08 16:37:13 -06:00
|
|
|
## Setup
|
|
|
|
|
|
|
|
|
|
After installing the skill configure the `script_dir` either in the settings json or on Mycroft Home. Default is `/home/mycroft/scripts`.
|
|
|
|
|
|
|
|
|
|
Place your executable scripts or programs in that directory with the name you want to call them. Replace spaces with dashes.
|
|
|
|
|
|
|
|
|
|
## Usage Examples
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
Hey Mycroft, run the backup script.
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
This will execute the script `/home/mycroft/scripts/backup` if it exists.
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
Hey Mycroft, execute total wipe program.
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
This will execute the script `/home/mycroft/total-wipe` if it exists.
|
|
|
|
|
|
|
|
|
|
## Todo
|
|
|
|
|
|
|
|
|
|
- Check if script is still running or not
|
|
|
|
|
- Check if script exited with succes or failure
|
|
|
|
|
- Track multiple scripts simultaneously
|
|
|
|
|
- Save script output with ability to read it back later?
|
