slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;bin: more scripts how-tos

Browse Source
This commit is contained in:
Simon Michael 2020-08-15 10:52:49 -07:00
parent c7f1800185
commit 8023d1e8d7
1 changed files with 54 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
bin/README.md
View File

@ -1,5 +1,7 @@
Miscellaneous hledger add-ons, bash scripts, example make rules, etc. Miscellaneous hledger add-ons, bash scripts, example make rules, etc.
## hledger scripts
The hledger-*.hs scripts here are example/experimental hledger [add-on commands]. The hledger-*.hs scripts here are example/experimental hledger [add-on commands].
See <https://hledger.org/scripting.html> for more about this. See <https://hledger.org/scripting.html> for more about this.
@ -24,29 +26,61 @@ Scripts overview, simplest first:
[stack]: https://www.fpcomplete.com/haskell/get-started [stack]: https://www.fpcomplete.com/haskell/get-started
[cabal]: https://www.haskell.org/cabal [cabal]: https://www.haskell.org/cabal
## Installing a single script How to:
$ curl -sO https://raw.githubusercontent.com/simonmichael/hledger/master/bin/hledger-check.hs ### Install all scripts as addon commands
$ chmod +x hledger-check.hs
$ ./hledger-check.hs --help
If you put the script somewhere in your $PATH, it will also show up as a hledger command,
so this also works:
$ hledger check -- --help
Note the `--`, which is required to separate script options from hledger options:
$ hledger [HLEDGEROPTS] ADDONCMD [-- ADDONOPTS]
## Installing all scripts
$ git clone https://github.com/simonmichael/hledger $ git clone https://github.com/simonmichael/hledger
$ # add hledger/bin/ to your $PATH # add hledger/bin/ to your $PATH
$ hledger # addons appear in command list $ hledger # scripts now appear in commands list
$ hledger-print-location.hs --help # run script directly
$ hledger print-location -- --help # or run it via hledger, -- is needed before script options
### Install a single script without getting hledger source
$ cd ~/bin # somewhere in your $PATH
$ curl -sO https://raw.githubusercontent.com/simonmichael/hledger/master/bin/hledger-check.hs
$ chmod +x hledger-check.hs
$ hledger-check.hs --help
$ hledger check -- --help
### Create a new script
The example scripts follow a template that implements hledger's
standard command line options and help, so it's a good idea to use one
as your starting point. The hledger- naming is not required, but it
causes scripts to show up in the hledger commands list. On unix,
your new script should be marked executable. This should do it:
# While in the hledger source directory:
$ cp bin/hledger-swap-dates.hs bin/hledger-foo.hs
# Customise hledger-foo.hs, at least the command name and help in cmdmode
$ bin/hledger-foo.hs --help
foo [OPTIONS]
My new foo command.
...
$ hledger foo -- --help
foo [OPTIONS]
My new foo command.
...
### Run ghcid on a script
# Ensure any extra packages the script imports from are installed in the current package db
# (running the script auto-installs them, but only in your user package db):
$ stack install string-qq
$ stack exec -- ghcid bin/hledger-foo.hs
...
Ok, one module loaded.
All good (1 module, at 10:50:48)
### Run ghci on a script
stack exec -- ghcid bin/hledger-import-shared-expenses.hs # Install any extra packages in the current package db, as above:
$ stack install string-qq
stack ghci bin/hledger-import-shared-expenses.hs $ stack ghci bin/hledger-foo.hs
...
Ok, one module loaded.
Loaded GHCi configuration from /private/var/folders/r7/f9j9c2zd1k97v47cr84j_qvc0000gn/T/haskell-stack-ghci/d0bde1be/ghci-script
ghci>