Merge pull request 'Add per-subcommand help using abra help <subcommand>' (#61) from command_help_2 into main
Reviewed-on: coop-cloud/abra#61
This commit is contained in:
commit
b79e35f982
203
abra
203
abra
@ -35,6 +35,7 @@ Usage:
|
||||
abra [options] server <host> apps [--status]
|
||||
abra [options] upgrade
|
||||
abra [options] version
|
||||
abra [options] help [<subcommands>...]
|
||||
|
||||
Options:
|
||||
-e, --env=<path> Environment variables to load
|
||||
@ -143,12 +144,12 @@ eval "var_$1+=($value)"; else eval "var_$1=$value"; fi; return 0; fi; done
|
||||
return 1; }; stdout() { printf -- "cat <<'EOM'\n%s\nEOM\n" "$1"; }; stderr() {
|
||||
printf -- "cat <<'EOM' >&2\n%s\nEOM\n" "$1"; }; error() {
|
||||
[[ -n $1 ]] && stderr "$1"; stderr "$usage"; _return 1; }; _return() {
|
||||
printf -- "exit %d\n" "$1"; exit "$1"; }; set -e; trimmed_doc=${DOC:1:1429}
|
||||
usage=${DOC:40:1165}; digest=cb5e2
|
||||
shorts=(-s -e -h '' '' '' '' '' '' '' '' '' '' '')
|
||||
longs=(--stack --env --help --server --domain --app-name --pass --auto --status --skip-check --force --no-tty --user --all)
|
||||
argcounts=(1 1 0 1 1 1 0 0 0 0 0 0 1 0); node_0(){ value __stack 0; }; node_1(){
|
||||
value __env 1; }; node_2(){ switch __help 2; }; node_3(){ value __server 3; }
|
||||
printf -- "exit %d\n" "$1"; exit "$1"; }; set -e; trimmed_doc=${DOC:1:1470}
|
||||
usage=${DOC:40:1206}; digest=b4523
|
||||
shorts=(-h -e -s '' '' '' '' '' '' '' '' '' '' '')
|
||||
longs=(--help --env --stack --server --domain --app-name --pass --auto --status --skip-check --force --no-tty --user --all)
|
||||
argcounts=(0 1 1 1 1 1 0 0 0 0 0 0 1 0); node_0(){ switch __help 0; }; node_1(){
|
||||
value __env 1; }; node_2(){ value __stack 2; }; node_3(){ value __server 3; }
|
||||
node_4(){ value __domain 4; }; node_5(){ value __app_name 5; }; node_6(){
|
||||
switch __pass 6; }; node_7(){ switch __auto 7; }; node_8(){ switch __status 8; }
|
||||
node_9(){ switch __skip_check 9; }; node_10(){ switch __force 10; }; node_11(){
|
||||
@ -158,65 +159,68 @@ value _service_ a; }; node_17(){ value _src_ a; }; node_18(){ value _dst_ a; }
|
||||
node_19(){ value _args_ a true; }; node_20(){ value _secret_ a; }; node_21(){
|
||||
value _version_ a; }; node_22(){ value _cmd_ a; }; node_23(){ value _data_ a; }
|
||||
node_24(){ value _command_ a; }; node_25(){ value _host_ a; }; node_26(){
|
||||
value _user_ a; }; node_27(){ value _port_ a; }; node_28(){ _command app; }
|
||||
node_29(){ _command new; }; node_30(){ _command list; }; node_31(){ _command ls
|
||||
}; node_32(){ _command deploy; }; node_33(){ _command undeploy; }; node_34(){
|
||||
_command config; }; node_35(){ _command delete; }; node_36(){ _command rm; }
|
||||
node_37(){ _command logs; }; node_38(){ _command cp; }; node_39(){
|
||||
_command check; }; node_40(){ _command ps; }; node_41(){ _command run; }
|
||||
node_42(){ _command secret; }; node_43(){ _command auto; }; node_44(){
|
||||
_command generate; }; node_45(){ _command insert; }; node_46(){ _command server
|
||||
}; node_47(){ _command add; }; node_48(){ _command init; }; node_49(){
|
||||
_command apps; }; node_50(){ _command upgrade; }; node_51(){ _command version; }
|
||||
node_52(){ optional 0 1 2; }; node_53(){ optional 52; }; node_54(){ optional 3
|
||||
}; node_55(){ optional 4; }; node_56(){ optional 5; }; node_57(){ optional 6; }
|
||||
node_58(){ optional 7; }; node_59(){ required 53 28 29 54 55 56 57 58 14; }
|
||||
node_60(){ either 30 31; }; node_61(){ required 60; }; node_62(){ optional 8; }
|
||||
node_63(){ required 53 28 61 62 54; }; node_64(){ optional 9; }; node_65(){
|
||||
required 53 28 15 32 64; }; node_66(){ required 53 28 15 33; }; node_67(){
|
||||
required 53 28 15 34; }; node_68(){ either 35 36; }; node_69(){ required 68; }
|
||||
node_70(){ optional 10; }; node_71(){ required 53 28 15 69 70; }; node_72(){
|
||||
optional 16; }; node_73(){ required 53 28 15 37 72; }; node_74(){
|
||||
required 53 28 15 38 17 18; }; node_75(){ required 53 28 15 39; }; node_76(){
|
||||
required 53 28 15 40; }; node_77(){ optional 11; }; node_78(){ optional 12; }
|
||||
node_79(){ oneormore 19; }; node_80(){ required 53 28 15 41 77 78 16 79; }
|
||||
node_81(){ required 53 28 15 42 43 57; }; node_82(){ optional 22; }; node_83(){
|
||||
required 53 28 15 42 44 20 21 82 57; }; node_84(){
|
||||
required 53 28 15 42 45 20 21 23 57; }; node_85(){ either 20 13; }; node_86(){
|
||||
required 85; }; node_87(){ required 53 28 15 42 69 86 57 70; }; node_88(){
|
||||
optional 79; }; node_89(){ required 53 28 15 24 88; }; node_90(){ optional 26; }
|
||||
node_91(){ optional 27; }; node_92(){ required 53 46 47 25 90 91; }; node_93(){
|
||||
required 53 46 61; }; node_94(){ required 53 46 25 36; }; node_95(){
|
||||
required 53 46 25 48; }; node_96(){ required 53 46 25 49 62; }; node_97(){
|
||||
required 53 50; }; node_98(){ required 53 51; }; node_99(){
|
||||
either 59 63 65 66 67 71 73 74 75 76 80 81 83 84 87 89 92 93 94 95 96 97 98; }
|
||||
node_100(){ required 99; }; cat <<<' docopt_exit() {
|
||||
[[ -n $1 ]] && printf "%s\n" "$1" >&2; printf "%s\n" "${DOC:40:1165}" >&2
|
||||
exit 1; }'; unset var___stack var___env var___help var___server var___domain \
|
||||
value _user_ a; }; node_27(){ value _port_ a; }; node_28(){
|
||||
value _subcommands_ a true; }; node_29(){ _command app; }; node_30(){
|
||||
_command new; }; node_31(){ _command list; }; node_32(){ _command ls; }
|
||||
node_33(){ _command deploy; }; node_34(){ _command undeploy; }; node_35(){
|
||||
_command config; }; node_36(){ _command delete; }; node_37(){ _command rm; }
|
||||
node_38(){ _command logs; }; node_39(){ _command cp; }; node_40(){
|
||||
_command check; }; node_41(){ _command ps; }; node_42(){ _command run; }
|
||||
node_43(){ _command secret; }; node_44(){ _command auto; }; node_45(){
|
||||
_command generate; }; node_46(){ _command insert; }; node_47(){ _command server
|
||||
}; node_48(){ _command add; }; node_49(){ _command init; }; node_50(){
|
||||
_command apps; }; node_51(){ _command upgrade; }; node_52(){ _command version; }
|
||||
node_53(){ _command help; }; node_54(){ optional 0 1 2; }; node_55(){
|
||||
optional 54; }; node_56(){ optional 3; }; node_57(){ optional 4; }; node_58(){
|
||||
optional 5; }; node_59(){ optional 6; }; node_60(){ optional 7; }; node_61(){
|
||||
required 55 29 30 56 57 58 59 60 14; }; node_62(){ either 31 32; }; node_63(){
|
||||
required 62; }; node_64(){ optional 8; }; node_65(){ required 55 29 63 64 56; }
|
||||
node_66(){ optional 9; }; node_67(){ required 55 29 15 33 66; }; node_68(){
|
||||
required 55 29 15 34; }; node_69(){ required 55 29 15 35; }; node_70(){
|
||||
either 36 37; }; node_71(){ required 70; }; node_72(){ optional 10; }
|
||||
node_73(){ required 55 29 15 71 72; }; node_74(){ optional 16; }; node_75(){
|
||||
required 55 29 15 38 74; }; node_76(){ required 55 29 15 39 17 18; }; node_77(){
|
||||
required 55 29 15 40; }; node_78(){ required 55 29 15 41; }; node_79(){
|
||||
optional 11; }; node_80(){ optional 12; }; node_81(){ oneormore 19; }
|
||||
node_82(){ required 55 29 15 42 79 80 16 81; }; node_83(){
|
||||
required 55 29 15 43 44 59; }; node_84(){ optional 22; }; node_85(){
|
||||
required 55 29 15 43 45 20 21 84 59; }; node_86(){
|
||||
required 55 29 15 43 46 20 21 23 59; }; node_87(){ either 20 13; }; node_88(){
|
||||
required 87; }; node_89(){ required 55 29 15 43 71 88 59 72; }; node_90(){
|
||||
optional 81; }; node_91(){ required 55 29 15 24 90; }; node_92(){ optional 26; }
|
||||
node_93(){ optional 27; }; node_94(){ required 55 47 48 25 92 93; }; node_95(){
|
||||
required 55 47 63; }; node_96(){ required 55 47 25 37; }; node_97(){
|
||||
required 55 47 25 49; }; node_98(){ required 55 47 25 50 64; }; node_99(){
|
||||
required 55 51; }; node_100(){ required 55 52; }; node_101(){ oneormore 28; }
|
||||
node_102(){ optional 101; }; node_103(){ required 55 53 102; }; node_104(){
|
||||
either 61 65 67 68 69 73 75 76 77 78 82 83 85 86 89 91 94 95 96 97 98 99 100 103
|
||||
}; node_105(){ required 104; }; cat <<<' docopt_exit() {
|
||||
[[ -n $1 ]] && printf "%s\n" "$1" >&2; printf "%s\n" "${DOC:40:1206}" >&2
|
||||
exit 1; }'; unset var___help var___env var___stack var___server var___domain \
|
||||
var___app_name var___pass var___auto var___status var___skip_check var___force \
|
||||
var___no_tty var___user var___all var__type_ var__app_ var__service_ var__src_ \
|
||||
var__dst_ var__args_ var__secret_ var__version_ var__cmd_ var__data_ \
|
||||
var__command_ var__host_ var__user_ var__port_ var_app var_new var_list var_ls \
|
||||
var_deploy var_undeploy var_config var_delete var_rm var_logs var_cp var_check \
|
||||
var_ps var_run var_secret var_auto var_generate var_insert var_server var_add \
|
||||
var_init var_apps var_upgrade var_version; parse 100 "$@"
|
||||
local prefix=${DOCOPT_PREFIX:-''}; unset "${prefix}__stack" "${prefix}__env" \
|
||||
"${prefix}__help" "${prefix}__server" "${prefix}__domain" \
|
||||
var__command_ var__host_ var__user_ var__port_ var__subcommands_ var_app \
|
||||
var_new var_list var_ls var_deploy var_undeploy var_config var_delete var_rm \
|
||||
var_logs var_cp var_check var_ps var_run var_secret var_auto var_generate \
|
||||
var_insert var_server var_add var_init var_apps var_upgrade var_version var_help
|
||||
parse 105 "$@"; local prefix=${DOCOPT_PREFIX:-''}; unset "${prefix}__help" \
|
||||
"${prefix}__env" "${prefix}__stack" "${prefix}__server" "${prefix}__domain" \
|
||||
"${prefix}__app_name" "${prefix}__pass" "${prefix}__auto" "${prefix}__status" \
|
||||
"${prefix}__skip_check" "${prefix}__force" "${prefix}__no_tty" \
|
||||
"${prefix}__user" "${prefix}__all" "${prefix}_type_" "${prefix}_app_" \
|
||||
"${prefix}_service_" "${prefix}_src_" "${prefix}_dst_" "${prefix}_args_" \
|
||||
"${prefix}_secret_" "${prefix}_version_" "${prefix}_cmd_" "${prefix}_data_" \
|
||||
"${prefix}_command_" "${prefix}_host_" "${prefix}_user_" "${prefix}_port_" \
|
||||
"${prefix}app" "${prefix}new" "${prefix}list" "${prefix}ls" "${prefix}deploy" \
|
||||
"${prefix}undeploy" "${prefix}config" "${prefix}delete" "${prefix}rm" \
|
||||
"${prefix}logs" "${prefix}cp" "${prefix}check" "${prefix}ps" "${prefix}run" \
|
||||
"${prefix}secret" "${prefix}auto" "${prefix}generate" "${prefix}insert" \
|
||||
"${prefix}server" "${prefix}add" "${prefix}init" "${prefix}apps" \
|
||||
"${prefix}upgrade" "${prefix}version"
|
||||
eval "${prefix}"'__stack=${var___stack:-}'
|
||||
"${prefix}_subcommands_" "${prefix}app" "${prefix}new" "${prefix}list" \
|
||||
"${prefix}ls" "${prefix}deploy" "${prefix}undeploy" "${prefix}config" \
|
||||
"${prefix}delete" "${prefix}rm" "${prefix}logs" "${prefix}cp" "${prefix}check" \
|
||||
"${prefix}ps" "${prefix}run" "${prefix}secret" "${prefix}auto" \
|
||||
"${prefix}generate" "${prefix}insert" "${prefix}server" "${prefix}add" \
|
||||
"${prefix}init" "${prefix}apps" "${prefix}upgrade" "${prefix}version" \
|
||||
"${prefix}help"; eval "${prefix}"'__help=${var___help:-false}'
|
||||
eval "${prefix}"'__env=${var___env:-}'
|
||||
eval "${prefix}"'__help=${var___help:-false}'
|
||||
eval "${prefix}"'__stack=${var___stack:-}'
|
||||
eval "${prefix}"'__server=${var___server:-}'
|
||||
eval "${prefix}"'__domain=${var___domain:-}'
|
||||
eval "${prefix}"'__app_name=${var___app_name:-}'
|
||||
@ -240,7 +244,10 @@ eval "${prefix}"'_command_=${var__command_:-}'
|
||||
eval "${prefix}"'_host_=${var__host_:-}'
|
||||
eval "${prefix}"'_user_=${var__user_:-}'
|
||||
eval "${prefix}"'_port_=${var__port_:-}'
|
||||
eval "${prefix}"'app=${var_app:-false}'; eval "${prefix}"'new=${var_new:-false}'
|
||||
if declare -p var__subcommands_ >/dev/null 2>&1; then
|
||||
eval "${prefix}"'_subcommands_=("${var__subcommands_[@]}")'; else
|
||||
eval "${prefix}"'_subcommands_=()'; fi; eval "${prefix}"'app=${var_app:-false}'
|
||||
eval "${prefix}"'new=${var_new:-false}'
|
||||
eval "${prefix}"'list=${var_list:-false}'; eval "${prefix}"'ls=${var_ls:-false}'
|
||||
eval "${prefix}"'deploy=${var_deploy:-false}'
|
||||
eval "${prefix}"'undeploy=${var_undeploy:-false}'
|
||||
@ -259,9 +266,10 @@ eval "${prefix}"'add=${var_add:-false}'
|
||||
eval "${prefix}"'init=${var_init:-false}'
|
||||
eval "${prefix}"'apps=${var_apps:-false}'
|
||||
eval "${prefix}"'upgrade=${var_upgrade:-false}'
|
||||
eval "${prefix}"'version=${var_version:-false}'; local docopt_i=1
|
||||
eval "${prefix}"'version=${var_version:-false}'
|
||||
eval "${prefix}"'help=${var_help:-false}'; local docopt_i=1
|
||||
[[ $BASH_VERSION =~ ^4.3 ]] && docopt_i=2; for ((;docopt_i>0;docopt_i--)); do
|
||||
declare -p "${prefix}__stack" "${prefix}__env" "${prefix}__help" \
|
||||
declare -p "${prefix}__help" "${prefix}__env" "${prefix}__stack" \
|
||||
"${prefix}__server" "${prefix}__domain" "${prefix}__app_name" \
|
||||
"${prefix}__pass" "${prefix}__auto" "${prefix}__status" \
|
||||
"${prefix}__skip_check" "${prefix}__force" "${prefix}__no_tty" \
|
||||
@ -269,12 +277,13 @@ declare -p "${prefix}__stack" "${prefix}__env" "${prefix}__help" \
|
||||
"${prefix}_service_" "${prefix}_src_" "${prefix}_dst_" "${prefix}_args_" \
|
||||
"${prefix}_secret_" "${prefix}_version_" "${prefix}_cmd_" "${prefix}_data_" \
|
||||
"${prefix}_command_" "${prefix}_host_" "${prefix}_user_" "${prefix}_port_" \
|
||||
"${prefix}app" "${prefix}new" "${prefix}list" "${prefix}ls" "${prefix}deploy" \
|
||||
"${prefix}undeploy" "${prefix}config" "${prefix}delete" "${prefix}rm" \
|
||||
"${prefix}logs" "${prefix}cp" "${prefix}check" "${prefix}ps" "${prefix}run" \
|
||||
"${prefix}secret" "${prefix}auto" "${prefix}generate" "${prefix}insert" \
|
||||
"${prefix}server" "${prefix}add" "${prefix}init" "${prefix}apps" \
|
||||
"${prefix}upgrade" "${prefix}version"; done; }
|
||||
"${prefix}_subcommands_" "${prefix}app" "${prefix}new" "${prefix}list" \
|
||||
"${prefix}ls" "${prefix}deploy" "${prefix}undeploy" "${prefix}config" \
|
||||
"${prefix}delete" "${prefix}rm" "${prefix}logs" "${prefix}cp" "${prefix}check" \
|
||||
"${prefix}ps" "${prefix}run" "${prefix}secret" "${prefix}auto" \
|
||||
"${prefix}generate" "${prefix}insert" "${prefix}server" "${prefix}add" \
|
||||
"${prefix}init" "${prefix}apps" "${prefix}upgrade" "${prefix}version" \
|
||||
"${prefix}help"; done; }
|
||||
# docopt parser above, complete command for generating this parser is `docopt.sh abra`
|
||||
|
||||
PROGRAM_NAME=$(basename "$0")
|
||||
@ -488,11 +497,26 @@ stack_logs (){
|
||||
# abra app ..
|
||||
#######################################
|
||||
|
||||
###### .. app (list|ls)
|
||||
###### .. app ls
|
||||
|
||||
help_app_ls (){
|
||||
help_app_list
|
||||
}
|
||||
|
||||
sub_app_ls (){
|
||||
sub_app_list
|
||||
}
|
||||
|
||||
help_app_list (){
|
||||
echo "abra [options] app (list|ls) [--status] [--server=<server>]
|
||||
|
||||
List your exciting apps
|
||||
|
||||
OPTIONS
|
||||
--status Show whether apps are deployed (warning! slow!)
|
||||
--server=<server> Filter to a specific server"
|
||||
}
|
||||
|
||||
sub_app_list (){
|
||||
SERVER="$abra___server"
|
||||
if [ -z "$SERVER" ]; then
|
||||
@ -560,7 +584,19 @@ sub_app_list (){
|
||||
# Align table `-t` based on tab characters -s`^V<Tab>`
|
||||
}
|
||||
|
||||
###### .. app new [--domain=<domain> --server=<server>]
|
||||
###### .. app new
|
||||
help_app_new (){
|
||||
echo "abra [options] app new [--server=<server>] [--domain=<domain>] [--pass] [--auto] <type>
|
||||
|
||||
Create a new app of <type> (e.g. wordpress or custom-html)
|
||||
|
||||
OPTIONS
|
||||
--server=<server> Specify which server to use (default: prompt)
|
||||
--domain=<domain> Set the domain name (default: prompt)
|
||||
--auto Auto-generate secrets (default: no)
|
||||
--pass Store generated secrets in pass (default: no)"
|
||||
}
|
||||
|
||||
sub_app_new (){
|
||||
require_abra_dir
|
||||
get_servers
|
||||
@ -634,6 +670,14 @@ sub_app_new (){
|
||||
}
|
||||
|
||||
###### .. app <domain> deploy
|
||||
help_app_deploy (){
|
||||
echo "abra [options] app <domain> deploy [--skip-check]
|
||||
|
||||
Deploy app <domain> to the configured server
|
||||
|
||||
OPTIONS
|
||||
--skip-check Don't check whether app definition is up-to-date first"
|
||||
}
|
||||
sub_app_deploy (){
|
||||
load_instance
|
||||
load_instance_env
|
||||
@ -1047,6 +1091,29 @@ sub_version() {
|
||||
echo "$ABRA_VERSION"
|
||||
}
|
||||
|
||||
###### .. help
|
||||
sub_help() {
|
||||
SUBCOMMAND=$(IFS="_"; echo "${abra__subcommands_[*]}")
|
||||
if [ -z "$SUBCOMMAND" ]; then
|
||||
printf "%s" "$DOC"
|
||||
exit
|
||||
fi
|
||||
HELP_CMD="help_${SUBCOMMAND}"
|
||||
if type "$HELP_CMD" > /dev/null 2>&1; then
|
||||
"$HELP_CMD"
|
||||
else
|
||||
HELP_COMMANDS=$(declare -Ff | grep 'help_' | cut -d' ' -f3 | sed 's/_/ /g')
|
||||
error "No help found for '$abra__subcommands_'
|
||||
|
||||
Try one of these:
|
||||
${HELP_COMMANDS//help /}"
|
||||
fi
|
||||
}
|
||||
|
||||
#######################################
|
||||
# cheeky docker aliases
|
||||
#######################################
|
||||
|
||||
###### .. stack <args>...
|
||||
sub_stack() {
|
||||
# shellcheck disable=SC2068
|
||||
@ -1075,9 +1142,9 @@ abra() {
|
||||
declare abra___stack abra___env abra__command_ abra__args_ \
|
||||
abra__secret_ abra__version_ abra__data_ abra___user abra__host_ \
|
||||
abra__type_ abra__port_ abra__user_ abra__service_ abra__src_ abra__dst_ \
|
||||
abra__app_ abra___server abra___domain abra___force abra___pass \
|
||||
abra___server abra___domain abra___force abra___pass \
|
||||
abra___auto abra___status abra___no_tty abra___skip_check \
|
||||
abra___app_name
|
||||
abra__subcommands_ abra___app_name
|
||||
|
||||
if ! type tput > /dev/null 2>&1; then
|
||||
tput() {
|
||||
|
||||
Loading…
Reference in New Issue
Block a user