Commands
Version
You can check the version of your aux4 CLI tool.
1> aux4 aux4 version1 aux4 5.0.0
2 2025 aux4. aux4 is created and maintained by the aux4 community.
3 https://aux4.ioMan
Display the documentation of the command.
1> aux4 aux4 man aux4 version1version
2Display the version of aux4.It's the same as using --help.
1> aux4 aux4 version --help1version
2Display the version of aux4.Source
Display the source code of the command.
1> aux4 aux4 source aux4 man11 set:help=true
22 profile:mainIt's the same as using --showSource
1> aux4 aux4 man --showSource11 set:help=true
22 profile:mainWhich
Display where the command is defined.
1> aux4 aux4 which aux4 version1aux4/aux4@5.0.0 aux4 → versionFor local .aux4 files, it will display the path to the file.
1> aux4 aux4 which hello1.aux4 main → hello
2/Users/user/my-scripts/.aux4It's the same as using --whereIsIt
1> aux4 aux4 version --whereIsIt1aux4/aux4@5.0.0 aux4 → versionShell
Start an interactive aux4 shell where you can run commands without the aux4 prefix. Type exit to quit.
1> aux4 aux4 shell1aux4> hello --name World
2Hello World
3aux4> exitWhen stdin is piped, it runs in batch mode, executing each line as a command:
1> echo "hello --name World" | aux4 aux4 shell1Hello WorldCompletion
Generate shell completion scripts for your shell. Supports bash, zsh, fish, and powershell.
1> aux4 aux4 completion --shell zshAdd it to your shell profile for automatic tab completion of aux4 commands, flags, and option values.
For zsh, add this to your ~/.zshrc:
1eval "$(aux4 aux4 completion --shell zsh)"For bash, add this to your ~/.bashrc:
1eval "$(aux4 aux4 completion --shell bash)"Hooks
List all registered hooks in the current environment. Hooks are cross-cutting interceptors that run before, after, or on error of any command.
1> aux4 aux4 hooksFilter by command pattern:
1> aux4 aux4 hooks --command "main/deploy"Filter by package:
1> aux4 aux4 hooks --package mycompany/deploy-hooksYou can also use --showHooks on any command to see its hooks:
1> aux4 deploy --showHooksSee Hooks for full documentation.
Global Flags
These flags control how aux4 loads configuration:
--local
Only load .aux4 files from the current directory. By default, aux4 traverses parent directories and loads all .aux4 files it finds.
1> aux4 -local hello --name World--noPackages
Don't load installed packages from ~/.aux4.config/. Only local .aux4 files are loaded.
1> aux4 -noPackages hello --name World