Merge pull request #306 into master
All checks were successful
docker-finance / all (push) Successful in 34m22s

12d9d31d client: docker: completion: add help to `plugins` (Aaron Fiore)
17692e61 client: docker: lib_plugins: update usage help (Aaron Fiore)
0e40b89b container: finance: lib_plugins: update usage help (Aaron Fiore)
This commit was merged in pull request #306.
This commit is contained in:
2026-02-26 10:40:57 -08:00
3 changed files with 28 additions and 10 deletions

View File

@@ -2,7 +2,7 @@
# docker-finance | modern accounting for the power-user
#
# Copyright (C) 2024-2025 Aaron Fiore (Founder, Evergreen Crypto LLC)
# Copyright (C) 2024-2026 Aaron Fiore (Founder, Evergreen Crypto LLC)
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
@@ -131,7 +131,7 @@ function docker-finance::completion()
find "${DOCKER_FINANCE_CLIENT_REPO}"/client/plugins/docker "${_args[@]}" -printf 'repo/%P\n' 2>/dev/null
})
declare -r _plugins
mapfile -t _reply < <(compgen -W "${_plugins[*]}" -- "$_cur")
mapfile -t _reply < <(compgen -W "help ${_plugins[*]}" -- "$_cur")
;;
esac
declare -r _reply

View File

@@ -2,7 +2,7 @@
# docker-finance | modern accounting for the power-user
#
# Copyright (C) 2024 Aaron Fiore (Founder, Evergreen Crypto LLC)
# Copyright (C) 2024,2026 Aaron Fiore (Founder, Evergreen Crypto LLC)
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
@@ -71,14 +71,32 @@ function lib_plugins::__parse_args()
\e[32mUsage:\e[0m
$ $global_usage <repo${global_arg_delim_1}plugin | custom${global_arg_delim_1}plugin> [args]
$ $global_usage <help | [TAB COMPLETION]> [args]
\e[32mArguments:\e[0m
[None | help]: show this usage help
[TAB COMPLETION]: run given shell plugin
custom = custom plugins in custom plugin location
repo = repository plugins in repository location
[args]: arguments to plugin
\e[32mExamples:\e[0m
\e[37;2m# Execute a repository plugin in '${_repo}'\e[0m
\e[37;2m# See this usage help\e[0m
$ $global_usage help
\e[37;2m# The output of tab completion\e[0m
$ $global_usage \\\t\\\t
custom/example.bash help repo/bitcoin.bash repo/example.bash repo/tor.bash
\e[37;2m# Execute a repository shell plugin in '${_repo}'\e[0m
$ $global_usage repo${global_arg_delim_1}example.bash \"I'm in repo\"
\e[37;2m# Execute a custom plugin in '${_custom}'\e[0m
\e[37;2m# Execute a custom shell plugin in '${_custom}'\e[0m
$ $global_usage custom${global_arg_delim_1}example.bash \"I'm in custom\"
"

View File

@@ -2,7 +2,7 @@
# docker-finance | modern accounting for the power-user
#
# Copyright (C) 2024-2025 Aaron Fiore (Founder, Evergreen Crypto LLC)
# Copyright (C) 2024-2026 Aaron Fiore (Founder, Evergreen Crypto LLC)
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
@@ -71,7 +71,7 @@ function lib_plugins::__parse_args()
\e[32mUsage:\e[0m
$ $global_usage [help | [TAB COMPLETION]] [args]
$ $global_usage <help | [TAB COMPLETION]> [args]
\e[32mArguments:\e[0m
@@ -91,8 +91,8 @@ function lib_plugins::__parse_args()
\e[37;2m# The output of tab completion\e[0m
$ $global_usage \\\t\\\t
custom/billing/invoice.bash help repo/timew_to_timeclock.bash
custom/billing/manage.bash repo/example.bash
custom/billing/invoice.bash custom/example.bash repo/example.bash
custom/billing/manage.bash help repo/timew_to_timeclock.bash
\e[37;2m# Execute a repository shell plugin in '${_repo}'\e[0m
$ $global_usage repo${global_arg_delim_1}example.bash \"I'm in repo\"