Add utils and shell aliases
[babashka-scripts.git] / README.md
1 # Babashka Scripts
2
3 Miscellaneous [babashka](https://babashka.org "babashka website") scripts I wrote for my own personal use.
4
5 ## Requirements
6
7 babashka (>= 0.2.9)
8
9 ## Usage
10
11 Clone this repository.
12
13 ``` sh
14 cd ~/dev
15 git clone https://njoseph.me/gitweb/babashka-scripts.git
16 ```
17
18 Add the following lines to your shell configuration file.
19
20 ``` sh
21 export BABASHKA_PRELOADS='(run! load-file (map #(str (System/getProperty "user.home") "/dev/babashka-scripts/" %) ["lib.clj" "utils.clj"]))'
22 export BABASHKA_PRELOADS=$BABASHKA_PRELOADS" (require '[utils :refer :all])"
23 export PATH=$PATH:$HOME/dev/babashka-scripts
24 ```
25
26 Some useful aliases.
27
28 ``` sh
29 alias gup="bb -e '(git-pull-rebase-branch)'"
30 ```
31
32 ## Organization
33
34 `lib.clj` contains functions that the other scripts might use. It must be loaded
35 first.
36
37 `utils.clj` contains standalone utilities that can be executed directly. These are
38 convenient to use through shell aliases.
39
40 The remaining Clojure files are executable scripts.