Feature Idea: CLI config tool

Development
,
1

Would it be useful to have a command line configuration tool parallel to webconf? Here’s the idea:

Idea

You got one script (bash, sh, py), let’s name it zynconf.sh for now. You can type your configuration request like this (examples, hope it’s understandable in context):


zynconf.sh --help // outputs the options
zynconf.sh --backup-save-config // stores a backup in a certain place
zynconf.sh --backup-restore-config-latest // restore most recently saved backup file (config only)
zynconf.sh --audio-driverconfig "dtoverlay=hifiberry-dacplusadcpro\nforce_eeprom_read=0" // stores a certain audio configuration
zynconf.sh --library-package-install "Hydrogen Drumkits" // install Hydrogen Drumkits package
zynconf.sh --sensors // outputs resource usage and temperature sensor data
zynconf.sh --snapshot-clearlaststate // delete last probably corrupted snapshot which denies to load
zynconf.sh --update // well, update
zynconf.sh --restore // abort hanging action (like loading a patch) and get back to working UI

And so on.

Possible use cases

  • When webconf isn’t working
  • When webconf isn’t accessable (No computer, no network connection, you’re in the bands rehearsal room)
  • When you don’t want to rely on webconfs spinning wheel loading indicator but you want to monitor the process with a verbose output (think data backup, package download)
  • Someone in the forum is abroad and asks how he/she can fix their broken zynth without webconf access
  • You fiddled to much with your configuration, you can restore the latest working configuration with one line.
  • You want quicky to copy things from a usb storage to your device without webconf

How to prevent double maintance?

  • Script is the main location for defining actions, webconf uses the script.

What else?

  • Would be great to be able to access tty command line from UI and attach a keyboard.
  • For troubleshooting you can boot your zynthian directly to tty cli to manage problems (last-snapshot-issue and the lot)
  • Maybe even an error screen forwards to CLI with touch/keyboard input possibilities.
  • I don’t know how you would achieve some kind of auto completion for options and arguments for greater accessabliltiy.
  • You could of course also use a menu which then triggers the commands for better usability. But that would be not suitable regarding the double maintaince argument above, so here it would be better so access the menu by zynconf.sh --menu or so.

What do you think?

5 Likes