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

;doc:completions: readme edits

Browse Source
This commit is contained in:
Simon Michael 2025-07-24 20:09:41 +01:00
parent 90d4224d5b
commit 55f12d89e0
1 changed files with 8 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
hledger/shell-completion/README.md
View File

@ -6,6 +6,7 @@ Context-sensitive completions are usually triggered by pressing the tab key once
## bash completions ## bash completions
An old demo: An old demo:
[![asciicast](https://asciinema.org/a/227935.svg)](https://asciinema.org/a/227935) [![asciicast](https://asciinema.org/a/227935.svg)](https://asciinema.org/a/227935)
To use hledger's bash shell completions, these must be installed on your system: To use hledger's bash shell completions, these must be installed on your system:
@ -53,24 +54,16 @@ Or you can source it in your current bash session for testing.
### Packaging the bash completions ### Packaging the bash completions
It's great when hledger packagers can make shell completions just work for users. The `hledger-completion.bash` script is available in the `hledger` package tarball on Hackage,
and on Github in the release bindists or at
Currently there is one completion script: `hledger-completion.bash`. `https://github.com/simonmichael/hledger/blob/TAG/hledger/shell-completion/hledger-completion.bash`.
It is included in the hledger package's tarball on Hackage. (Eg: https://github.com/simonmichael/hledger/blob/1.43/hledger/shell-completion/hledger-completion.bash)
hledger versions before 1.40 don't have up-to-date bash completions.
For hledger 1.40, the up-to-date script is at
https://github.com/simonmichael/hledger/blob/39dfe5702e1b401f1883d814907d242958eec9c1/hledger/shell-completion/hledger-completion.bash.
Since hledger 1.41, this is included in the Github release bindists, and available at urls like
https://github.com/simonmichael/hledger/blob/1.41/hledger/shell-completion/hledger-completion.bash
After it has been loaded, this script will provide completions for hledger, hledger-ui and hledger-web. After it has been loaded, this script will provide completions for hledger, hledger-ui and hledger-web.
Note if it is installed only as `hledger`, bash-completion will not load it until the user types `hledger<SPACE><TAB>`. Note if it is installed only as `hledger`, bash-completion will not load it until the user types `hledger<SPACE><TAB>`.
Consider also symbolic-linking it as `hledger-ui` and `hledger-web`, so that `hledger-ui<SPACE><TAB>` and `hledger-web<SPACE><TAB>` will also load it. Consider also symbolic-linking it as `hledger-ui` and `hledger-web`, so that `hledger-ui<SPACE><TAB>` and `hledger-web<SPACE><TAB>` will also load it.
Here is a place to track the status of shell completions in hledger packages. As of 1.40: hledger bash completions packaging status as of 1.40:
- Homebrew: includes slightly stale completions, installed as `hledger` only - Homebrew: includes slightly stale completions, installed as `hledger` only
- Arch Linux AUR: packaging in progress - Arch Linux AUR: packaging in progress
@ -86,11 +79,11 @@ They may be out of date, please help by updating them.
hledger completions are shipped with fish: <https://github.com/fish-shell/fish-shell/blob/master/share/completions/hledger.fish> hledger completions are shipped with fish: <https://github.com/fish-shell/fish-shell/blob/master/share/completions/hledger.fish>
They may be out of date, please help by updating them. They may be out of date, please help by updating them.
## Creating completions for other shells ## Creating/updating completion scripts
A rough guide: A rough guide:
1. Create an m4 template for your completion script, eg `hledger-completion.SHELL.m4` where SHELL is the name of the new shell. 1. Create an m4 template for your completion script, eg `hledger-completion.SHELL.m4` where SHELL is the name of the shell.
2. Add a rule in `Makefile` to transform this to `hledger-completion.SHELL`. 2. Add a rule in `Makefile` to transform this to `hledger-completion.SHELL`.