FUNCTIONS.md

Function Reference

Complete alphabetical index of all available functions across all modules.

Base Module

Function	Description	Module
action(message)	Print action message	base
answer_is_yes()	Check if user response is yes	base
ask(question)	Prompt user for input	base
ask_for_confirmation(question)	Prompt for yes/no confirmation	base
ask_for_sudo()	Request and maintain sudo privileges	base
bot(message)	Print message with bot emoji	base
cancelled(message)	Print cancellation message	base
error(message)	Print error message	base
execute(command [message])	Execute command with spinner	base
get_answer()	Get last user input	base
kill_all_subprocesses()	Kill all background jobs	base
ok(message)	Print success message	base
print_error(message [details])	Print formatted error	base
print_error_stream()	Print errors from stdin	base
print_in_color(text color)	Print colored text	base
print_in_green(text)	Print green text	base
print_in_purple(text)	Print purple text	base
print_in_red(text)	Print red text	base
print_in_yellow(text)	Print yellow text	base
print_question(message)	Print question prompt	base
print_result(exit_code message)	Print result based on exit code	base
print_success(message)	Print formatted success	base
print_warning(message)	Print formatted warning	base
running(message)	Print running message	base
show_spinner(pid command message)	Display animated spinner	base
skip_questions(args...)	Check for non-interactive mode	base
success(message)	Print success message	base
terminal(command)	Open new Terminal window (macOS)	base
warn(message)	Print warning message	base

System Module

Function	Description	Module
add_cron_job(frequency command)	Add cron job	system
add_to_path_if_not_exists(path)	Add to PATH if missing	system
add_value_and_uncomment(file key value)	Add value and uncomment line	system
append_to_bashrc(text [skip_newline])	Append to bashrc/bash.local	system
cmd_exists(command)	Check if command exists	system
extract(file)	Extract compressed file	system
get_os()	Get normalized OS name	system
get_os_version()	Get OS version	system
is_arch_linux()	Check if Arch Linux	system
is_debian()	Check if Debian/Ubuntu	system
is_macos()	Check if macOS	system
is_supported_version(current required)	Compare versions	system
jq_replace(file field value)	Replace JSON field	system
mkd(directory)	Create directory	system
read_kernel_name()	Get kernel name	system
read_os_name()	Get OS identifier	system
read_os_version()	Get OS version	system
replace_str(file key pattern replacement)	Replace pattern in file	system
set_default_shell(executable_path)	Set default shell	system
set_trap(signal command)	Set signal trap	system
symlink(source target)	Create symlink	system
uncomment_str(file key)	Uncomment lines	system

Git Module

Function	Description	Module
clone_git_repo_in(target url)	Clone git repository	git
is_git_repository()	Check if in git repo	git

Homebrew Module

Function	Description	Module
brew_bundle_install(options...)	Install from Brewfile	homebrew
brew_cleanup()	Clean up old formulas	homebrew
get_brew_default_path()	Get Homebrew path	homebrew
initialize_brew()	Initialize Homebrew	homebrew
is_brew_installed()	Check if Homebrew installed	homebrew

Python Module

Function	Description	Module
is_pip_installed()	Check if pip installed	python
is_pip_pkg_installed(package)	Check if pip package installed	python
is_pip3_installed()	Check if pip3 installed	python
is_pip3_pkg_installed(package)	Check if pip3 package installed	python
is_pyenv_installed()	Check if pyenv installed	python
pip_install(package)	Install pip package	python
pip_install_from_file(file_path)	Install from requirements	python
pip3_install(package)	Install pip3 package	python
pip3_install_from_file(file_path)	Install from requirements	python
pyenv_install(version)	Install Python version	python

Node Module

Function	Description	Module
is_npm_installed()	Check if npm installed	node
is_npm_pkg_installed(package)	Check if npm package installed	node
is_npx_installed()	Check if npx installed	node
is_yarn_pkg_installed(package)	Check if yarn package installed	node
npm_install(package)	Install npm package globally	node
npm_install_from_file(file_path)	Install from package list	node
npx_install(package)	Install via yarn/npx	node
sudo_npm_install(package)	Install npm package with sudo	node

Ruby Module

Function	Description	Module
gem_install(gem)	Install Ruby gem	ruby
is_ruby_installed()	Check if Ruby installed	ruby

Fish Module

Function	Description	Module
fish_cmd_exists(command)	Check if command exists in Fish	fish
fisher_install()	Install Fisher	fish
fisher_install_package(package)	Install Fisher plugin	fish
fisher_package_is_installed(package)	Check if Fisher plugin installed	fish
is_fisher_installed()	Check if Fisher installed	fish
is_omf_installed()	Check if OMF installed	fish
omf_install()	Install Oh My Fish	fish
omf_install_package(package)	Install OMF package	fish
omf_package_is_installed(package)	Check if OMF package installed	fish

Rust Module

Function	Description	Module
cargo_install(crate)	Install Rust crate	rust
is_cargo_installed()	Check if Cargo installed	rust

Go Module

Function	Description	Module
go_install(package)	Install Go package	go
is_go_installed()	Check if Go installed	go

Java Module

Function	Description	Module
is_sdkman_installed()	Check if SDKMAN installed	java
sdk_install(candidate [version])	Install SDK via SDKMAN	java
sdkman_install()	Install SDKMAN	java

Gofish Module

Function	Description	Module
gofish_install()	Install Gofish	gofish
gofish_pkg_install(package)	Install Gofish package	gofish
is_gofish_installed()	Check if Gofish installed	gofish
is_gofish_pkg_installed(package)	Check if Gofish package installed	gofish

Pacman Module

Function	Description	Module
aur_helper_is_installed(helper)	Check if AUR helper installed	pacman
auto_remove()	Remove orphaned packages	pacman
install_aur_package(package [helper])	Install AUR package	pacman
install_package(package)	Install pacman package	pacman
package_is_installed(package)	Check if package installed	pacman
pacman_install_from_file(file_path)	Install from package file	pacman
pacman_update()	Synchronize package databases	pacman
pacman_upgrade()	Upgrade all packages	pacman
remove_package(package)	Remove package	pacman

MacPorts Module

Function	Description	Module
is_macports_installed()	Check if MacPorts installed	macports
is_macports_port_installed(port)	Check if port installed	macports
macports_install(port)	Install MacPorts port	macports

Quick Search Tips

• Use your browser's find function (Ctrl/Cmd+F) to search for specific functions
• Functions are organized alphabetically within each module
• Click module links for detailed documentation and usage examples
• Most functions follow naming pattern: <tool>_<action> or is_<tool>_installed

Common Patterns

Check if tool is installed

if is_<tool>_installed; then
    # Tool-specific operations
fi

Install packages

<tool>_install "package-name"
<tool>_install_from_file "path/to/file"

OS detection

if is_macos; then
    # macOS-specific code
elif is_debian; then
    # Debian/Ubuntu-specific code
elif is_arch_linux; then
    # Arch Linux-specific code
fi