diff --git a/README.md b/README.md index a9e4cff..b25092b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,114 @@ # cli-scripts -Useful CLI scripts that I think are worth sharing. \ No newline at end of file +Useful CLI scripts that I think are worth sharing. + +**NOTE: With all of these, you'll need to customize the environment for yourself. I have yet to make things like home directories and what-not generic variables** + +## Prerequisites + +The scripts in the scripts directory rely heavily the expectation that you +already have a number of applications installed on your system. If you're +on a Debian or Ubuntu-ish system, then installing them should be more or less +as simple as an `apt install {whatever}`. For the rest of you, you'll have to +make your own way. Sorry. + +Here is the prerequisite list broken down by script: + +### apps + +This is a little ncurses menu I built for myself. Dependencies will be +determined by how you decide to customize the menu for yourself (i.e. what +applications you want to put in the menu), but there is one common +dependency. + +* `dialog` - I think this comes automatically with Debian/Ubuntu + +### birthdate + +prints the initial installation date of your system + +* None + +### cecho + +provides colorized echo messages + +* The **bash** version of `printf` for best results + +### checkit + +performs a grammatical version of code linting, but on your text documents. + +* `vale` - https://vale.sh/ +* `go` - Their Dockerfile (for the docker implementation) calls for golang 1.21 + +### dirsz + +dumps a list of the directory sizes recursively from your CWD + +* None + +### fif + +A "find-in-files" utility for the console. + +* `fd-find` - a better substitute for the standard 'find' command + +### forecast + +Dumpe a three-day forecast to your console + +* `curl`, and a network connection (for access to wttr.in) + +### ifcheck + +shows the state of your ethernet/wifi interface + +* `ip` - I can't remember if this was something I had to install after the fact. + +### memo + +* None - However, you'll need to modify the script to specify your own editor, and you'll have to create a "memos" directory in your Documents folder. + +### netcheck + +Tells you if the internet is accessible from your shell. + +* None + +### oggrec + +Starts a recording from the console, using your default mic + +* `alsa-utils` - provides `arecord` which captures the raw audio input +* `vorbis-tools` - provides `oggenc` which encodes it to ogg and stores it to the specified file + +### status + +Combines the ifcheck, netcheck, wx, and a few other commands into a full screen status display + +* `ifcheck` - see above +* `netcheck` - see above +* `cecho` - see above +* `wx` - seee below + +### vmemo + +records a short, low-resolution (small size) 15 second audio memo from your default mic + +* `arecord` +* `mp3 codecs` + +### wx + +displays the current weather conditions for your area. You'll need to customize the script. + +* `ansiweather` - available in Debian and Ubuntu repositories. + +### yootoob + +A utility for searching and watching youtube videos without a browser + +* `ytfzf` (which I believe also has a dependency on `yt-dlp`) + + diff --git a/scripts/--help b/scripts/--help new file mode 100644 index 0000000..42ca898 Binary files /dev/null and b/scripts/--help differ diff --git a/apps b/scripts/apps similarity index 100% rename from apps rename to scripts/apps diff --git a/birthdate b/scripts/birthdate similarity index 100% rename from birthdate rename to scripts/birthdate diff --git a/cecho b/scripts/cecho similarity index 100% rename from cecho rename to scripts/cecho diff --git a/checkit b/scripts/checkit similarity index 100% rename from checkit rename to scripts/checkit diff --git a/dirsz b/scripts/dirsz similarity index 100% rename from dirsz rename to scripts/dirsz diff --git a/fif b/scripts/fif similarity index 100% rename from fif rename to scripts/fif diff --git a/forecast b/scripts/forecast similarity index 100% rename from forecast rename to scripts/forecast diff --git a/ifcheck b/scripts/ifcheck similarity index 100% rename from ifcheck rename to scripts/ifcheck diff --git a/memo b/scripts/memo similarity index 100% rename from memo rename to scripts/memo diff --git a/netcheck b/scripts/netcheck similarity index 100% rename from netcheck rename to scripts/netcheck diff --git a/oggrec b/scripts/oggrec similarity index 100% rename from oggrec rename to scripts/oggrec diff --git a/status b/scripts/status similarity index 100% rename from status rename to scripts/status diff --git a/vmemo b/scripts/vmemo similarity index 100% rename from vmemo rename to scripts/vmemo diff --git a/scripts/wx b/scripts/wx new file mode 100755 index 0000000..f902b8f --- /dev/null +++ b/scripts/wx @@ -0,0 +1,8 @@ +#!/usr/bin/env bash +if ! [[ -n $1 ]]; then + loc="Cowley,UK" +else + loc=$1 +fi + +ansiweather -l $loc -u imperial -s true -i false diff --git a/yootoob b/scripts/yootoob similarity index 100% rename from yootoob rename to scripts/yootoob