git: minor changes
[babashka-scripts.git] / README.md
1 # Babashka Scripts
2
3 Miscellaneous [babashka](https://babashka.org "babashka website") scripts written for my own personal use.
4
5 ## Requirements
6
7 babashka (>= 0.4.0)
8
9 ## Usage
10
11 Clone this repository.
12
13 ``` sh
14 git clone https://njoseph.me/gitweb/babashka-scripts.git
15 ```
16
17 The list of available commands can be found by running `bb tasks` in the directory where the file `bb.edn` is present.
18
19 ``` sh
20 The following tasks are available:
21
22 gup Do a git pull and rebase branch with master in a given directory.
23 gpa Runs `git pull` on all the git repositories in a given directory.
24 ebook-to-audiobook A utility to listen to your ebooks using TTS programs. Only tested on macOS with epub files.
25 install-deb Install a Debian package given a direct URL to the .deb file.
26 install-deb-gh Install a Debian package given a GitHub URL.
27 ```
28
29 Some tasks can also take arguments.
30
31 ``` sh
32 bb ebook-to-audiobook the-great-gatsby.epub
33 ```
34
35 ## Shell aliases
36
37 ``` sh
38 # bash, zsh
39 source /path/to/babashka-scripts/bb-aliases.sh
40 alias task = bb --config ~/dev/babashka-scripts/bb.edn
41
42 # nu
43 source /path/to/babashka-scripts/bb-aliases.nu
44 alias task = bb --config ~/dev/babashka-scripts/bb.edn
45 ```
46
47 *Example:* To pull all the repositories in a directory, run
48
49 ``` sh
50 task gpa .
51 ```
52
53 There is a utility `bbe` to run tasks in the current working directory in `bb-aliases.sh`.
54
55
56 *Example:* To pull all the repositories in a directory, run
57
58 ``` sh
59 bbe gpa
60 ```