Scripts extracted from my [dotfiles](https://github.com/purarue/dotfiles), see [index](#script-index)

This includes:

- Pure utility/wrangling scripts like [`lower`](./shellscripts/lower), [`upper`](./shellscripts/upper), [`chomp`](./shellscripts/chomp), [`rcut`](./shellscripts/rcut), [`tally`](./shellscripts/tally), [`unique`](./shellscripts/unique), [`average`](./shellscripts/average); which help process outputs of other commands, which are commonly used by other shellscripts I put up on other repositories -- hence the reason to make this repo so they're easily installable
- Some helper/conversion scripts like [`to-png`](./shellscripts/to-png), [`to-jpeg`](./shellscripts/to-jpeg), [`rotate-img`](./shellscripts/rotate-img), [`tq`](./shellscripts/tq) (`jq` for `toml`)
- Cross-Platform scripts that provide interaction with clipboard/prompting user for input/sending notifications on Mac/Linux/Termux

## Requires

This _does not install these_ and requires you to have these available (on your `$PATH`) before installing this:

- [GNU coreutils](https://www.gnu.org/software/coreutils/) (or some compatible set of utilities) - e.g., `cut`, `uniq`, `tr`
- [util-linux](https://en.wikipedia.org/wiki/Util-linux) - e.g., `shuf`, `rev`, `kill`
- `find`
- `grep`
- `curl`
- `wget`
- `awk`
- `sed`
- `realpath`

Optional/Recommended (some scripts here will fail if these aren't present)

- [`jq`](https://stedolan.github.io/jq/) - command line JSON parser
- [`fzf`](https://github.com/junegunn/fzf#installation) - fuzzy finder
- [`fd`](https://github.com/sharkdp/fd#installation) - user-friendly 'find' alternative

Needed for installing/building core utils used in other scripts here:

- `python3` - <https://www.python.org/downloads/>
- `go` - <https://go.dev/doc/install> (skips installs if `go` not found)

## Install

To check for dependencies/path issues, run `make`

To install, run `make install`:

```bash
git clone https://github.com/purarue/pura-utils
cd ./pura-utils
make  # check for dependencies
make install
```

Or use [`bpkg`](https://github.com/bpkg/bpkg) to automate the manual `git clone`/`cd`/`make`:

```
bpkg install -g purarue/pura-utils
```

To setup `go` to build packages, add something like this to your `.zshrc`/`.bashrc`:

```bash
# if not already set
export XDG_DATA_HOME="${HOME}/.local/share"

# Go (see 'go help install')
export GOPATH="${XDG_DATA_HOME}/go"
export GOBIN="${GOPATH}/bin"

# update $PATH
export PATH="\
${HOME}/.local/bin:\
${XDG_DATA_HOME}/go/bin:\
${PATH}"
```

On [`termux`](https://termux.dev/en/), you need to install the [`termux-api`](https://github.com/termux/termux-api) package (from `F-Droid`)

## Contents

Requires `python 3.8+`/`golang` to install:

### Script Index

`make install` installs:

- a few `go` CLI tools - (See <https://go.dev/doc/install> for install instructions)
  - [`newest`](https://github.com/purarue/newest) - print most recently modified file in directory
  - [`chomp`](https://github.com/purarue/chomp) - remove whitespace/empty lines from command output
  - [`on_machine`](https://github.com/purarue/on_machine) - detect what operating system/machine you're currently on
- The `./python-src` package, which includes helper functions, see [python-src/README.md](./python-src/README.md). Also installs required python libraries for any python scripts here

... and shellscripts:

#### shellscripts

##### File/Utility Scripts

- [`havecmd`](./shellscripts/havecmd) - command to check if commands are available
- [`dir-size`](./shellscripts/dir-size) - prints the total size of a directory
- [`symlink`](./shellscripts/symlink) - a helper script to make a symlink since I always forget how to
- [`lastdown`](./shellscripts/lastdown)/[`mvlast`](./shellscripts/mvlast) - prints/moves the latest file in your downloads (`$XDG_DOWNLOAD_DIR` or `~/Downloads`) folder
- [`get-extension`](./shellscripts/get-extension), [`remove-extension`](./shellscripts/remove-extension), [`replace-extension`](./shellscripts/replace-extension) - helpers to create output filename strings
- Lots of date shorthands: [`daystamp`](./shellscripts/daystamp), [`daystamp_`](./shellscripts/daystamp_), [`epoch`](./shellscripts/epoch), [`month`](./shellscripts/month), [`weekday`](./shellscripts/weekday), [`year`](./shellscripts/year)
- [`path`](./shellscripts/path): prints your `$PATH`, separated by newlines

##### File Formats

- [`json-compress`](./shellscripts/json-compress) - compresses JSON (removes extra spaces/newlines), only writes to the file if size of data was changed
- [`tq`](./shellscripts/tq) - converts a TOML file to JSON, usually piped to [jq](https://github.com/stedolan/jq). e.g.,: `tq <data.toml | jq '.conf'`
- [`to-png`](./shellscripts/to-png)/[`to-jpg`](./shellscripts/to-jpg) - converts an image to a png/jpg
- [`img-download`](./shellscripts/img-download) - downloads an image from your clipboard to your tmpdir, moves it so that the extension is valid
- [`shebang`](./shellscripts/shebang) - creates a script with the given shebang. If a known language, adds a basic template
- [`html-head`](./shellscripts/html-head): a script to generate `<head>` tags for generated HTML, I often use this like: `pandoc README.md | html-head -a css-dark-mode -a css-pre-wrap | remsync-html-from-stdin` to convert some local markdown file to a basic dark-mode webpage and publish it onto my website with [`remsync`](https://github.com/purarue/vps/blob/master/remsync)

##### Data Wrangling

- [`lower`](./shellscripts/lower)/[`upper`](./shellscripts/upper) - converts all text from STDIN to lowercase/uppercase
- [`prefix`](./shellscripts/prefix)/[`suffix`](./shellscripts/suffix)/[`surround`](./shellscripts/surround) - prepends/adds a string to the beginning/end of each line from STDIN
- [`capitalize`](./shellscripts/capitalize) - 'capitalizes' (first letter of) input, e.g. WORD -> Word; word -> Word
- [`average`](./shellscripts/average) - finds the mean of numerical data piped from STDIN
- [`rcut`](./shellscripts/rcut) - `cut`, by indexing from the right instead
- [`sort-by-last-col`](./shellscripts/sort-by-last-col) - sorts text by last column of text; columns can vary in length
- [`unique`](./shellscripts/unique) - `uniq`, but doesn't require input to be sorted
- [`unique-ignore-case`](./shellscripts/unique-ignore-case) - `unique`, but ignores uppercase/lowercase
- [`tally`](./shellscripts/tally) - shorthand for `sort | uniq -c | sort -n`
- [`group-and-termgraph`](./shellscripts/group-and-termgraph) - takes lines of data and groups/graphs it using [termgraph](https://github.com/mkaz/termgraph). Sort of like a fancy `sort | uniq -c | sort -n`
##### Cross Platform Helpers

These use [`on_machine`](https://github.com/purarue/on_machine) to run different commands based on what operating system you're on

- [`openurl`](./shellscripts/openurl)/[`openurls`](./shellscripts/openurls) - URL opener
- [`clipcopy`](./shellscripts/clipcopy)/[`clippaste`](./shellscripts/clippaste) - save to/read from clipboard
- [`input-dialog`](./shellscripts/input-dialog) - prompts the user to enter some text with an OS-dialog
- [`notify`](./shellscripts/notify) - sends a OS notification (`notify-send` on linux/`applescript` on mac)
- [`picker`](./shellscripts/picker) - prompts user to pick from lines received from STDIN

##### Git

- [`gitopen`](./shellscripts/gitopen) - opens the current git repository/branch in your browser
- Helpers that return `0` if the condition is met, they're used like: `in-gitdir && command_do_something`
  - [`in-gitdir`](./shellscripts/in-gitdir) - currently in a git directory
  - [`has-git-remote`](./shellscripts/has-git-remote) - has a `git remote --verbose`
  - [`git-has-changes`](./shellscripts/git-has-changes) - files have changes or there are untracked files
  - [`git-list-untracked-files`](./shellscripts/git-list-untracked-files) - prints files that are not tracked by git
  - [`git-has-untracked-files`](./shellscripts/git-has-untracked-files) - exits with 0 if there are any untracked files

##### Media

- [`image-dimensions`](./shellscripts/image-dimensions) - prints the width/height for images passed as arguments
- [`gifme`](./shellscripts/gifme) - Creates a gif from a (section of a) video file. Lets you specify start/end times and an fps for the gif to run at
- [`list-movies`](./shellscripts/list-movies)/[`list-music`](./shellscripts/list-music) - lists any music/movies in the current directory recursively. any additional args are passed onto [`fd`](https://github.com/sharkdp/fd), e.g, with [`mlength`](https://github.com/purarue/mlength)
  - `list-music -X mlength -o sum` (find length of an album in current directory)
  - `list-movies -X mlength -d path -o min` (find shortest movie in current directory)
  - `list-movies -X mlength -d all | sort -n` (sort results by length)

##### Others:

- [`ix`](./shellscripts/ix) - terminal pastebin replacement -- anything piped to STDIN gets uploaded to <http://ix.io> and a link is copied to your clipboard