HomeSetup Developer Handbook
Standard-Tools
Table of contents
Aliases related functions
__hhs_alias
usage: __hhs_alias <alias_name>='<alias_expr>'
Purpose
Check if an alias does not exists and create it, otherwise just ignore it. Do not support the use of single quotes in the expression.
Returns
0 if the alias name was created (available); non-zero otherwise.
Parameters
- $1 Required : The alias to set/check.
- $2..$N Required : The alias expression.
Examples
__hhs_alias ls='ls -la' && echo OK
Output
N/A
__hhs_alias dir='ls -la' && echo OK
Output
OK
__hhs_aliases
usage: __hhs_aliases <alias> <alias_expr>
Options:
-l | --list : List all custom aliases.
-e | --edit : Open the aliases file for editing.
-r | --remove : Remove an alias.
Notes:
List all aliases : When [alias_expr] is NOT provided. If [alias] is provided, filter results using it.
Add/Set an alias : When both [alias] and [alias_expr] are provided.
Purpose
Manipulate custom aliases (add/remove/edit/list).
Returns
0 if the alias was created (available); non-zero otherwise.
Parameters
- $1 Optional : The alias name.
- $2 Conditional : The alias expression.
Examples
__hhs_aliases dir 'ls -la'
Output
Alias set: "dir" is 'ls -la'
__hhs_aliases -r dir
Output
Alias removed: "dir"
__hhs_aliases -s
Output
aa....................................... is aliased to '__hhs_aliases'
aks...................................... is aliased to 'load aks'
ama...................................... is aliased to 'load ama'
api...................................... is aliased to 'load api'
apigee................................... is aliased to 'load apigee'
apps..................................... is aliased to 'load apps'
argo..................................... is aliased to 'load ARGO'
cfg...................................... is aliased to 'load CFG'
...
...