EvergreenCrypto/docker-finance
1
1
Fork 1
Code Issues 31 Pull Requests Actions Releases 10 Activity

Merge pull request #231 into master

Browse Source 
0266157a client/container: usage help updates (Aaron Fiore)
This commit was merged in pull request #231.
This commit is contained in:
Aaron Fiore
2025-10-28 12:15:10 -07:00
parent 9bc6be3a49 0266157abe
commit ccaab13534
6 changed files with 30 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
client/src/docker/docker.bash
View File

@@ -60,26 +60,26 @@ function main()
Environment (all platforms):
gen \e[34;3mGenerate docker-finance environment\e[0m
gen \e[34;3mGenerate client/container environment\e[0m
edit \e[34;3mEdit existing client-side configurations\e[0m
All platforms:
build \e[34;3mBuild a new docker-finance image\e[0m
update \e[34;3mUpdate an existing docker-finance image\e[0m
backup \e[34;3mBackup existing instance image\e[0m
rm \e[34;3mRemove image, remove network (also stops container, if running)\e[0m
backup \e[34;3mBackup existing docker-finance image\e[0m
rm \e[34;3mRemove docker-finance image and network\e[0m
up \e[34;3mCreate network, bring up unique container, open shell\e[0m
down \e[34;3mStop and remove container, remove network\e[0m
start \e[34;3mStart existing container\e[0m
stop \e[34;3mStop running container\e[0m
up \e[34;3mBring up docker-finance services, open shell\e[0m
down \e[34;3mBring down docker-finance services, remove network\e[0m
start \e[34;3mStart existing docker-finance container\e[0m
stop \e[34;3mStop running docker-finance container\e[0m
run \e[34;3mSpawn a container with given command (container removed on exit)\e[0m
shell \e[34;3mOpen shell into running container\e[0m
run \e[34;3mSpawn docker-finance container with given command (container removed on exit)\e[0m
shell \e[34;3mOpen shell into running docker-finance container\e[0m
plugins \e[34;3mExecute given plugin available in plugins' path\e[0m
version \e[34;3mPrint current version of 'docker-finance' and its dependencies\e[0m
plugins \e[34;3mExecute a client-side categorical docker-finance plugin ('repo' or 'custom')\e[0m
version \e[34;3mPrint current version of docker-finance and its dependencies\e[0m
Dev-tools platform:

22
container/src/finance/finance.bash
View File

@@ -2,7 +2,7 @@
# docker-finance | modern accounting for the power-user
#
# Copyright (C) 2021-2024 Aaron Fiore (Founder, Evergreen Crypto LLC)
# Copyright (C) 2021-2025 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
@@ -51,15 +51,15 @@ function main()
\e[32mCommand:\e[0m
all \e[34;3mFetches, imports, generates taxes and reports w/ [args] year\e[0m
edit \e[34;3mEdit existing container data\e[0m
fetch \e[34;3mFetch remote accounts\e[0m
import \e[34;3mImport CSVs for given year (default: current year)\e[0m
hledger \e[34;3mRun CLI accounting commands\e[0m
hledger-ui \e[34;3mStart terminal UI\e[0m
edit \e[34;3mEdit container configurations, metadata and journals\e[0m
fetch \e[34;3mFetch prices, remote accounts and blockchain data\e[0m
import \e[34;3mImport CSV data since given year (default: current year)\e[0m
hledger \e[34;3mRun hledger commands\e[0m
hledger-ui \e[34;3mStart hledger terminal UI\e[0m
hledger-vui \e[34;3mStart visidata terminal UI\e[0m
hledger-web \e[34;3mStart web-based UI\e[0m
meta \e[34;3mSearch local financial metadata\e[0m
plugins \e[34;3mExecute given plugin available in plugins' path\e[0m
hledger-web \e[34;3mStart hledger web-based UI\e[0m
meta \e[34;3mSearch and view financial metadata\e[0m
plugins \e[34;3mExecute a categorical shell plugin (non-\`root\`)\e[0m
reports \e[34;3mGenerate balance sheet, income statement, etc.\e[0m
root \e[34;3mRun ROOT.cern instance for docker-finance analysis\e[0m
taxes \e[34;3mGenerate tax reports\e[0m
@@ -83,8 +83,8 @@ function main()
\e[37;2m# Show Carol's total USD value of Bitcoin across all asset accounts\e[0m
$ $global_basename friends${global_arg_delim_1}carol hledger bal assets cur:BTC --value=now
\e[37;2m# Generate quarterly reports for your vendor 'ABC Inc.' in the year 2023\e[0m
$ $global_basename vendors${global_arg_delim_1}abc_inc reports all${global_arg_delim_2}type interval=quarterly year=2023
\e[37;2m# Generate quarterly reports for your client 'ABC Inc.' in the year 2023\e[0m
$ $global_basename clients${global_arg_delim_1}abc_inc reports all${global_arg_delim_2}type interval=quarterly year=2023
"
#

2
container/src/finance/lib/internal/lib_edit.bash
View File

@@ -49,7 +49,7 @@ function lib_edit::__parse_args()
local -r _usage="
\e[32mDescription:\e[0m
Edit container configuration files and journals
Edit container configurations, metadata and journals
\e[32mUsage:\e[0m

2
container/src/finance/lib/internal/lib_fetch.bash
View File

@@ -49,7 +49,7 @@ function lib_fetch::__parse_args()
local -r _usage="
\e[32mDescription:\e[0m
Fetch prices, accounts and blockchains
Fetch prices, remote accounts and blockchain data
\e[32mUsage:\e[0m

10
container/src/finance/lib/internal/lib_hledger.bash
View File

@@ -88,7 +88,7 @@ function lib_hledger::__parse_hledger-import()
local -r _usage="
\e[32mDescription:\e[0m
Import all accounts' CSV data to produce viable journals (see README for setup)
Import all accounts' CSV data and produce viable journals
\e[32mUsage:\e[0m
@@ -96,14 +96,14 @@ function lib_hledger::__parse_hledger-import()
\e[32mArguments:\e[0m
Import year:
Import all accounts since given year:
year${global_arg_delim_2}<all|year>
year${global_arg_delim_2}<year>
\e[32mExamples:\e[0m
\e[37;2m# Import all years since 2020\e[0m
$ $global_usage year${global_arg_delim_2}2020
\e[37;2m# Import all years since 2018\e[0m
$ $global_usage year${global_arg_delim_2}2018
"
if [ "$#" -gt 1 ]; then

2
container/src/finance/lib/internal/lib_meta.bash
View File

@@ -57,7 +57,7 @@ function lib_meta::__parse_args()
local -r _usage="
\e[32mDescription:\e[0m
View financial metadata
Search and view financial metadata
\e[32mUsage:\e[0m