Adds README with descriptions

This commit is contained in:
Nemo 2020-07-29 01:18:03 +05:30
parent d5df0227d9
commit 941e30a33d
2 changed files with 133 additions and 3 deletions

110
README.md
View File

@ -1,3 +1,107 @@
scripts
=======
This lives in my ~/projects/scripts directory and is added to my $PATH.
# scripts
This lives in my `~/projects/scripts` directory and is added to my `$PATH`. Not a lot of this is used, but I leave them in here, just in case they are helpful to someone. Scripts are in various languages, including Bash, PHP, Python, Ruby, and Perl. This also collects helper scripts I've found on the Internet (Labelled `third-party`)
| Filename | what it does |
|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| alsa-info.sh | Third-party. Dump your alsa configuration for easier debugging. |
| ansi2html.sh | Third-party. pipe your colored shell output and get HTML out |
| archive-repo | helper script to archive a repo on GitHub by pushing it to an orphan branch |
| audible-strip-drm | Strip Audible DRM from all Audible-MP4 files in the current directory |
| aur.sh | dumb AUR helper, for when you don't have yay installed yet |
| avi2gif | convert an AVI file to a GIF at 10FPS. High quality |
| backlight | change keyboard brightness for laptops. |
| blacklist2hosts.php | convert a blacklist file (list of hosts) to a /etc/hosts format file with 0.0.0.0 prepended |
| bluetooth-pan.sh | Run PAN on a specific bluetooth device. |
| brightness.sh | change display brightness. Works primarily on laptops |
| byzanz-record-region.sh | Third-party. Select a screen region and record it using byzanz |
| byzanz-record-window.sh | Third-party. Select a window and record it using byzanz |
| calibre_cleanup.php | Old cleanup script for fixing namespace in EPUBs that won't open on my iPad |
| cbr2pdf | Change a CBR(Comic Book RAR archive) to a PDF |
| cbz2pdf | Change a CBZ(Comic Book ZIP archive) to a PDF |
| cbz-convertor.sh | Same as cbz.sh but also syncs them somewhere |
| cbz.sh | Zips given directories into .cbz (Comic Book ZIP) archives of the smame name (eg "folder name.cbz"). |
| ccg | Third-party. Generate a control graph from a PHP codebase |
| changed.sh | Search whole filesystem for changed files in the last $1 minutes |
| convertSTL.rb | Third-party. STL files support binary and ascii encodings. This helps convert b/w them |
| cpw | Third-party. build an array of all cpw procs for this user that aren't this one. |
| cwdterm.sh | Picks a sensible-terminal, used by i3. Currently forces alacritty. |
| djvu2pdf | Third-party. Convert a DJVU file to PDF |
| do-common.sh | Run S3 commands against Digital Ocean. Unfinished |
| do-get@ | Run S3 commands against Digital Ocean. Symlink to do-common. Idea was to switch like how busybox does |
| dydns.sh | I like my local system IP address (192.168.1.*) to be accessible over the network using https://me.captnemo.in. This updates the DNS server by making an API request to CloudFlare. |
| emojify | Third-party. Substitutes emoji aliases (like :sparkling_heart:) to emoji raw characters. |
| epub2mobi.sh | Convert all EPUB files in a directory recursively to MOBI using ebook-convert |
| extract_uimage.sh | Third-party. Extract contents from a uImage, which is the compressed linux kernel format. |
| flac2mp3 | Convert all flac files to mp3 in current directory in parallel using ffmpeg |
| frak | Generates a regex from a given input file containing all possible matches using the frak NPM package. |
| get_current_track.py | Gets my current playing track from /tmp/lastfm.html (which was updated with cron) or the cmus-now-playing status file, whichever existed. Unused now |
| get-current-track.sh | Same, but in Bash |
| ghissues2csv | Exports issues from a list of repositories to individual CSV files. |
| git-find-blob | Given a blob ID, finds the relevant commit |
| git-grab | Downloads a git directory from a webserver with an exposed .git directory |
| github-init-repo | Initialize a repo with a first commit and create it on GitHub |
| github-team-ssh-keys.sh | Get all SSH keys for a given team on GitHub |
| gitlistobjectbysize.sh | Third-party. Find large Git objects to find out what is taking space in your repository |
| git-pushall-branches | push all branches. |
| git-sync | This scrips intends to sync via git near-automatically |
| graphpath | Third-party. Graphpath generates an ASCII network diagram from the route table of a Unix/Linux |
| hda-analyzer | Third-party. Alsa debugging helper script |
| hosts | adblocking hosts file. I use this as fallback sometimes, since it committed |
| housekeeping | A housekeeping script that clears up space, syncs a few repositories |
| hsmarkdown.php | Third-party. PHP Markdown Extra with additional syntax for jsMath equations |
| i3-get-window-criteria | Third-party. Get criteria for use with i3 config commands |
| i3lock-fancy | Fancy i3lock |
| i3lock.sh | Custom i3lock script |
| i3-pomodoro | i3blocks pomodoro script |
| imguralbum.py | Third-party. Download a whole imgur album in one go. |
| json.sh | Third-party. Parse a JSON file using BASH. |
| LICENSE | Licenses for third party scripts. |
| lock.sh | Calls betterlockscreen |
| lowbatterycron.sh | Cron I run using systemd that notifies me if I am on low battery and power isn't connected |
| mdtable2csv | Third-party. Converts a markdown table in a file to CSV format |
| mobile-pass-sync@ | Sync helper for syncing my mobile-passwords. Now I use `housekeeping` |
| offline_filter.pl | Third-party. Simple liferea (and possibly for other things) conversion filter to download content for offline viewing during feed updates. |
| parallel | Third-party. GNU parallel |
| pass-show | Helper script to just output a one-line-password |
| pdf-parser.py | Third-party script to parse a PDF |
| plutil.pl | implementation of binary/UTF-8 (text) XML conversion of plist files |
| port_block_check.sh | Run this behind a firewall to see if there are any outbound ports that are blocked |
| prettyping | Third-party, runs a nice graphical ping |
| resty | Third-party. A tiny command line REST interface for bash and zsh. |
| reverse_video.sh | Reverse a video |
| rip-git.pl | Third-party. Brute force and download a publicly exposed .git directory |
| s3-common.sh | Do S3 operations from Bash |
| s3-delete | Do S3 operations from Bash |
| s3-get | Do S3 operations from Bash |
| s3-head | Do S3 operations from Bash |
| s3-put | Do S3 operations from Bash |
| screencast | Select a screen region and generate a nice GIF |
| screen-darken.sh | Darken my laptop screen by running xrandr |
| screen-off | Turn off the display by xset dpms. It will turn back on when on user-input |
| seagate | Old sync script that I used to sync content to an external HDD regularly |
| sem | GNU parallell (sem) |
| shrinkpdf | Third-party. Shrinks a PDF by downsampling images (and a few other things) |
| signcerts.sh | Runs dehydrated locally to update my certificates via LetsEncrypt. Sets my CloudFlare config and runs dehdyrated |
| sleepsize.sh | Checks and reports the file size every 5 seconds. Helpful when you're copying large files, or waiting for something to complete. |
| snippy.sh | Third-party. Helper script for i3 to let me create snippets and type them easily. |
| split-audio-by-chapters | Splits a audiobook by its various chapters. I added support for providing a chapters.txt file with chapter names in case the M4B file doesn't have correct names |
| split-by-audible | Similar to split-audio-by-chapters, but this one uses a different chapter-listing format, which is what you get when you copy the Audible tracklist from the Audible web player. |
| sql | Third-party. Runs SQL commands against different drivers based on DBURL. This is a GNU project |
| ssl-cipher-test.sh | Runs a SSL Cipher test by testing all available ciphers against an upstream server |
| stream-audio.sh | Streams pulseaudio to RTSP |
| swaks | Third-party. Swaks is a swiss-knife toolkit for testing SMTP |
| synaptic-tweaks.sh | Third-party. Minor configuration tweaks for synaptic touchpads |
| syncMedia | Old script for syncing content |
| syncrepos | Old script for syncing content. Now merged with housekeeping |
| undelete | Attempt to find open file descriptors that are pointing to deleted files and try to recover them |
| unimatrix | Third-party. Matrix animation on the terminal |
| update.koreader | Updates KOReader on my Kindle. |
| vimeo_downloader.sh | Third-party. Downloads a video fro Vimeo |
| vtt2srt | Converts a VTT subtitle file to SRT (PHP) |
| whoisplaying | Find out which process is playing audio. |
| xsetup | Touchpad and other X configuration. |
| yadisk | Download a file from Yandex Disk (like Dropbox) by using their API. |
| yubi-insert.sh | Run when I insert a yubikey. Checks the Serial, and if they don't match, lock my screen |
| yubilock.sh | Lock my screen when I remove my device. Runs using udev triggers |
| ec | script to edit common configuration |

26
ec Normal file
View File

@ -0,0 +1,26 @@
#!/bin/bash
#
# Attribution
# Written by cthulahoops.
# The idea is to provide a single interface for quickly editing various configurations.
#
declare -A configs
configs=(
['khal']=".config/khal/config"
['vdirsyncer']=".config/vdirsyncer/config"
['nvim']=".config/nvim/init.vim"
['bash']=".bashrc"
['tmux']=".tmux.conf"
['unison']=".unison/common"
['ec']='bin/ec'
)
case "$1" in
show)
echo "$HOME/${configs[$2]}"
;;
*)
exec $EDITOR "$HOME/${configs[$1]}"
esac