HomeSetup Developer Handbook¶
Applications handbook
Table of contents¶
Built-ins¶
"list"¶
usage: __hhs list [-flat] [-plugins] [-funcs]
Purpose¶
List all HHS App Plug-ins and Functions.
Returns¶
0 if the command was successfully executed; non-zero otherwise.
Parameters¶
- -flat : Instead of a formatted list, flat the items (e.g:. for bash completion).
- -plugins : Filter the list to display only plug-ins.
- -funcs : Filter the list to display only functions.
Examples¶
__hhs list
Output
HomeSetup application commands
-=- HHS Plug-ins -=-
1 settings
2 ask
3 starship
4 setup
5 updater
6 firebase
7 hspm
-=- HHS Functions -=-
1 docsify
2 board
3 sponsor
4 list
5 funcs
6 logs
7 sys-logs
8 man
9 reset
10 shorts
11 host-name
12 shopts
13 tests
14 color-tests
__hhs list -flat
Output
settings starship setup updater firebase hspm docsify board list funcs logs man reset host-name shopt tests color-tests
"funcs"¶
usage: __hhs funcs [regex_filter]
Purpose¶
Search for all __hhs functions pointing it's source file name and line number.
Returns¶
0 if the command was successfully executed; non-zero otherwise.
Examples¶
__hhs funcs
Output
N/A
"logs"¶
usage: __hhs logs [log_level]
Purpose¶
Retrieve HomeSetup logs. By default, this command is going to return 100 log lines. If the file contains more than that you can set the environment variable \"$HHS_LOG_LINES\" to a greater value and issue the command again.
Returns¶
0 if the command was successfully executed; non-zero otherwise.
Examples¶
__hhs logs
Output
Retrieving logs from /Users/runner/.hhs/log/hhsrc.log (last 100 lines) [level='ALL'] :
HomeSetup is starting: Mon Dec 18 17:23:17 -03 2023
12-18-23 17:23:17 INFO Initialization settings loaded: /Users/runner/.hhs/.homesetup.toml
12-18-23 17:23:17 INFO Loading dotfile: /Users/hjunior/.bash_env
12-18-23 17:23:17 INFO Loading dotfile: /Users/hjunior/.bash_colors
12-18-23 17:23:17 INFO Loading dotfile: /Users/hjunior/.bash_prompt
12-18-23 17:23:17 INFO Starting starship prompt
...
...
"man"¶
usage: __hhs man <bash_command>
Purpose¶
Fetch the ss64 manual from the website for the specified bash command.
Returns¶
0 if the command was successfully executed; non-zero otherwise.
Examples¶
__hhs man grep
Output
Opening SS64 man page for grep: https://ss64.com/bash/grep.html
"reset"¶
usage: __hhs reset
Purpose¶
Clear all cache, log and backup files and HomeSetup config files. Force re-create all using defaults.
Returns¶
0 if the command was successfully executed; non-zero otherwise.
Examples¶
__hhs reset
Output
Attention! Mark what you want to delete (8)
1 /Users/hjunior/.hhs/log/*.log
2 /Users/hjunior/.hhs/backup/*.bak
3 /Users/hjunior/.hhs/cache/*.cache
4 /Users/hjunior/.inputrc
5 /Users/hjunior/.hhs/.aliasdef
6 /Users/hjunior/.hhs/.starship.toml
7 /Users/hjunior/.hhs/.homesetup.toml
8 /Users/hjunior/.hhs/shell-opts.toml
[Enter] Accept [↑↓] Navigate [Space] Mark [I] Invert [Esc] Quit [1..8] Goto: