From ff0fe62facdbfe50de833861714dc30719542e03 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Tue, 17 Sep 2024 06:36:37 -0700 Subject: [PATCH] ;doc: cli, ui, web: mention/link to shell completions --- hledger-ui/hledger-ui.m4.md | 3 +++ hledger-web/hledger-web.m4.md | 3 +++ hledger/hledger.m4.md | 8 ++++++++ 3 files changed, 14 insertions(+) diff --git a/hledger-ui/hledger-ui.m4.md b/hledger-ui/hledger-ui.m4.md index a806ef08a..8b5170c55 100644 --- a/hledger-ui/hledger-ui.m4.md +++ b/hledger-ui/hledger-ui.m4.md @@ -77,6 +77,9 @@ _generaloptions_ With hledger-ui, the `--debug` option sends debug output to a `hledger-ui.log` file in the current directory. +If you use the bash shell, you can auto-complete flags by pressing TAB in the command line. +If this is not working see [Install > Shell completions](install.html#shell-completions). + # MOUSE In most modern terminals, you can navigate through the screens with a diff --git a/hledger-web/hledger-web.m4.md b/hledger-web/hledger-web.m4.md index 548299f75..bfd43ca63 100644 --- a/hledger-web/hledger-web.m4.md +++ b/hledger-web/hledger-web.m4.md @@ -131,6 +131,9 @@ Reporting options and/or query arguments can be used to set an initial query, which although not shown in the UI, will restrict the data shown (in addition to any search query entered in the UI). +If you use the bash shell, you can auto-complete flags by pressing TAB in the command line. +If this is not working see [Install > Shell completions](install.html#shell-completions). + # PERMISSIONS By default, hledger-web allows anyone who can reach it to view the journal diff --git a/hledger/hledger.m4.md b/hledger/hledger.m4.md index f064e3d9d..ac231a850 100644 --- a/hledger/hledger.m4.md +++ b/hledger/hledger.m4.md @@ -579,6 +579,14 @@ If you need that, you can do it in the shebang line instead. Eg: The config file feature has been added in hledger 1.40 and is considered *experimental*. +## Shell completions + +If you use the bash shell, you can optionally set up context-sensitive autocompletions when you press TAB in a hledger command line. +At a bash shell prompt, try pressing +`hledger` (should list all hledger commands) +or `hledger reg acct:` (should list your top-level account names). +If completions aren't working, or for more details, see [Install > Shell completions](install.html#shell-completions). + # Output ## Output destination