A lightweight shell library to streamline your development environment setup on Linux and macOS.
shell/
├── install.sh
├── upgrade.sh
├── uninstall.sh
└── src/
├── shell.sh # Main entry point
└── lib/
├── utils.sh
├── git.sh
├── docker.sh
└── ... # Add more as needed/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/pnguyen215/shell/master/install.sh)"/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/pnguyen215/shell/master/upgrade.sh)"/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/pnguyen215/shell/master/uninstall.sh)"Access the shell library by opening your terminal and using the commands below. Each command is designed to streamline development environment management on Linux and macOS. Examples are provided where applicable.
-
shell::version
Displays the current version of the shell library.
Example:shell::version -
shell::upgrade
Upgrades the shell CLI to the latest version available.
Example:shell::upgrade -
shell::uninstall
Removes the shell CLI and its associated files from the system.
Example:shell::uninstall -
shell::get_os_type
Identifies and returns the current operating system type as a standardized string (e.g., "linux" or "macos").
Example:shell::get_os_type -
shell::colored_echo
Outputs text to the terminal with customizable foreground colors usingtputand ANSI escape sequences. Requires a message and a color code (e.g., 46 for cyan).
Example:shell::colored_echo "Task completed" 46 -
shell::run_cmd
Executes a specified command and logs it to the terminal for tracking purposes.
Example:shell::run_cmd ls -l -
shell::run_cmd_eval
Executes a command usingevaland logs it, useful for dynamic command construction.
Example:shell::run_cmd_eval ls -l -
shell::is_command_available
Checks if a given command exists in the system's PATH, returning a success or failure status.
Example:shell::is_command_available git -
shell::install_package
Installs a package using the appropriate package manager for the OS (e.g.,aptfor Linux,brewfor macOS).
Example:shell::install_package git -
shell::remove_package
Uninstalls a package using the OS-appropriate package manager.
Example:shell::remove_package git -
shell::list_packages_installed
Lists all packages installed on the system via the native package manager.
Example:shell::list_packages_installed -
shell::create_directory_if_not_exists
Creates a directory (including nested paths) if it does not already exist.
Example:shell::create_directory_if_not_exists /path/to/dir -
shell::create_file_if_not_exists
Creates a file if it does not exist, leaving existing files unchanged.
Example:shell::create_file_if_not_exists config.txt -
shell::unlock_permissions
Assigns full permissions (read, write, execute;chmod 777) to a file or directory.
Example:shell::unlock_permissions ./my_script.sh -
shell::clip_cwd
Copies the current working directory path to the system clipboard.
Example:shell::clip_cwd -
shell::clip_value
Copies a specified text string to the system clipboard.
Example:shell::clip_value "Hello, World!" -
shell::get_temp_dir
Returns the OS-appropriate temporary directory path (e.g.,/tmpon Linux).
Example:TEMP_DIR=$(shell::get_temp_dir) -
shell::on_evict
Prints a command to the terminal without executing it, useful for debugging or logging.
Example:shell::on_evict ls -l -
shell::check_port
Checks if a TCP port is in use (listening). Use-nto suppress output and return a status only.
Examples:shell::check_port 8080shell::check_port 8080 -n
-
shell::kill_port
Terminates all processes listening on a specified TCP port. Use-nfor silent operation.
Examples:shell::kill_port 8080shell::kill_port 8080 -n
-
shell::copy_files
Copies a source file to one or more destination filenames in the current directory.
Example:shell::copy_files source.txt dest1.txt dest2.txt -
shell::move_files
Moves one or more files to a specified destination directory.
Example:shell::move_files /path/to/dest file1.txt file2.txt -
shell::remove_files
Deletes a file or directory recursively with elevated privileges (sudo rm -rf). Use with caution.
Example:shell::remove_files obsolete-dir -
shell::editor
Opens a file from a specified directory in a chosen text editor. Use-nto open in a new instance (if supported).
Examples:shell::editor ~/documentsshell::editor -n ~/documents
-
shell::download_dataset
Downloads a file from a URL and saves it with the specified filename.
Example:shell::download_dataset data.zip https://example.com/data.zip -
shell::unarchive
Extracts a compressed file based on its extension (e.g.,.zip,.tar.gz). Use-nfor no-overwrite mode.
Examples:shell::unarchive archive.zipshell::unarchive -n archive.tar.gz
-
shell::list_high_mem_usage
Displays processes consuming significant memory, sorted by usage.
Example:shell::list_high_mem_usage -
shell::open_link
Opens a URL in the default web browser. Use-nfor silent operation (no output).
Examples:shell::open_link https://example.comshell::open_link -n https://example.com
-
shell::loading_spinner
Displays a console loading spinner for a specified duration (in seconds). Use-nto run indefinitely until stopped.
Examples:shell::loading_spinner 10shell::loading_spinner -n 10
-
shell::measure_time
Measures and reports the execution time of a command in seconds.
Example:shell::measure_time sleep 2 -
shell::async
Runs a command or function asynchronously in the background. Use-nfor no output.
Examples:shell::async my_function arg1 arg2shell::async -n ls
-
shell::fzf_copy
Interactively selects a file to copy and a destination directory usingfzffor fuzzy finding.
Example:shell::fzf_copy -
shell::fzf_move
Interactively selects a file to move and a destination directory usingfzf.
Example:shell::fzf_move -
shell::fzf_remove
Interactively selects a file or directory to remove usingfzf.
Example:shell::fzf_remove -
shell::add_bookmarkAdds a bookmark for the current directory with the specified name. Example:shell::add_bookmark <bookmark name>
-
shell::remove_bookmarkDeletes a bookmark with the specified name from the bookmarks file. Example:shell::remove_bookmark <bookmark_name>
-
shell::remove_bookmark_linuxDeletes a bookmark with the specified name from the bookmarks file. Example:shell::remove_bookmark_linux <bookmark_name>
-
shell::list_bookmarkDisplays a formatted list of all bookmarks. Example:shell::list_bookmark -
shell::go_bookmarkNavigates to the directory associated with the specified bookmark name. Example:shell::go_bookmark <bookmark name>
-
shell::go_backNavigates to the previous working directory. -
shell::goto_versionDisplays the version of the goto script. -
shell::gotoMain function to handle user commands and navigate directories. Example:shell::goto [command]shell::goto_usage
-
shell::install_homebrewInstalls Homebrew using the official installation script. -
shell::removal_homebrewUninstalls Homebrew from the system. -
shell::install_oh_my_zshInstalls Oh My Zsh if it is not already present on the system. Example:shell::install_oh_my_zshshell::install_oh_my_zsh -n
-
shell::removal_oh_my_zshUninstalls Oh My Zsh by removing its directory and restoring the original .zshrc backup if available. Example:shell::removal_oh_my_zshshell::removal_oh_my_zsh -n
-
shell::read_confSources a configuration file, allowing its variables and functions to be loaded into the current shell. Example:shell::read_conf [-n] <filename>shell::read_conf ~/.my-configshell::read_conf -n ~/.my-config
-
shell::add_key_confAdds a configuration entry (key=value) to a constant configuration file. The value is encoded using Base64 before being saved. Example:shell::add_key_conf [-n] <key> <value>shell::add_key_conf my_setting "some secret value"shell::add_key_conf -n my_setting "some secret value"
-
shell::fzf_get_key_confInteractively selects a configuration key from a constant configuration file using fzf, then decodes and displays its corresponding value. -
shell::get_key_conf_valueRetrieves and outputs the decoded value for a given configuration key from the key configuration file. Example:shell::get_key_conf_value my_setting
-
shell::fzf_remove_key_confInteractively selects a configuration key from a constant configuration file using fzf, then removes the corresponding entry from the configuration file. Example:shell::fzf_remove_key_confshell::fzf_remove_key_conf -n
-
shell::fzf_update_key_confInteractively updates the value for a configuration key in a constant configuration file. The new value is encoded using Base64 before updating the file. Example:shell::fzf_update_key_confshell::fzf_update_key_conf -n
-
shell::exist_key_confChecks if a configuration key exists in the key configuration file. Example:shell::exist_key_conf <key>shell::exist_key_conf my_setting
-
shell::fzf_rename_key_confRenames an existing configuration key in the key configuration file. Example:shell::fzf_rename_key_conf [-n]
-
shell::is_protected_key_confChecks if the specified configuration key is protected. Example:shell::is_protected_key_conf <key>
-
shell::fzf_add_group_key_confGroups selected configuration keys under a specified group name. Example:shell::fzf_add_group_key_conf [-n]
-
shell::read_group_key_confReads and displays the configurations for a given group by group name. Example:shell::read_group_key_conf <group_name>shell::read_group_key_conf my_group
-
shell::fzf_remove_group_key_confInteractively selects a group name from the group configuration file using fzf, then removes the corresponding group entry. Example:shell::fzf_remove_group_key_conf [-n]
-
shell::fzf_update_group_key_confInteractively updates an existing group by letting you select new keys for that group. Example:shell::fzf_update_group_key_conf [-n]
-
shell::fzf_rename_group_key_confRenames an existing group in the group configuration file. Example:shell::fzf_rename_group_key_conf [-n]
-
shell::list_group_key_confLists all group names defined in the group configuration file. -
shell::fzf_view_group_key_confInteractively selects a group name from the group configuration file using fzf, then lists all keys belonging to the selected group and uses fzf to choose one key, finally displaying the decoded value for the selected key. -
shell::fzf_clone_group_key_confClones an existing group by creating a new group with the same keys. Example:shell::fzf_clone_group_key_conf [-n]
-
shell::sync_group_key_confSynchronizes group configurations by ensuring that each group's keys exist in the key configuration file. If a key listed in a group does not exist, it is removed from that group. If a group ends up with no valid keys, that group entry is removed. Example:shell::sync_group_key_conf [-n]
-
shell::send_telegram_messageSends a message via the Telegram Bot API.-
Parameters:
- -n : Optional dry-run flag. If provided, the command is printed using shell::on_evict instead of executed.
- token : The Telegram Bot API token.
- chat_id : The chat identifier where the message should be sent.
- message : The message text to send.
-
shell::send_telegram_message [-n] <token> <chat_id> <message>
-
-
shell::send_telegram_historical_gh_messageSends a historical GitHub-related message via Telegram using stored configuration keys.-
Parameters:
- -n : Optional dry-run flag. If provided, the command is printed using shell::on_evict instead of executed.
- message : The message text to send.
-
shell::send_telegram_historical_gh_message [-n] <message>
-
-
shell::send_telegram_attachmentSends one or more attachments (files) via Telegram using the Bot API asynchronously.-
Parameters:
- -n : Optional dry-run flag. If provided, the command is printed using shell::on_evict instead of executed.
- token : The Telegram Bot API token.
- chat_id : The chat identifier where the message should be sent.
- description: A text description that is appended to each attachment's caption along with a timestamp.
- filename_X: One or more filenames of the attachments to send.
-
shell::send_telegram_attachment [-n] <token> <chat_id> <description> [filename_1] [filename_2] [filename_3] ...
-
-
shell::fzf_zip_attachmentZips selected files from a specified folder and outputs the absolute path of the created zip file.-
Parameters:
- -n : Optional dry-run flag. If provided, the command is printed using shell::on_evict instead of executed.
- folder_path : The folder (directory) from which to select files for zipping.
-
shell::fzf_zip_attachment [-n] <folder_path>
-
-
shell::fzf_current_zip_attachmentReuses shell::fzf_zip_attachment to zip selected files from the current directory, then renames the resulting zip file to use the current directory's basename and places it inside the current directory.-
Parameters:
- -n : Optional dry-run flag. If provided, the command is printed using shell::on_evict instead of executed.
-
shell::fzf_current_zip_attachment [-n]
-
-
shell::fzf_send_telegram_attachmentUses fzf to interactively select one or more files from a folder (default: current directory), and sends them as attachments via the Telegram Bot API by reusing shell::send_telegram_attachment.-
Parameters:
- -n : Optional dry-run flag. If provided, the command is printed using shell::on_evict instead of executed.
- token: The Telegram Bot API token.
- chat_id: The chat identifier where the attachments are sent.
- description: A text description appended to each attachment's caption along with a timestamp.
- folder_path: (Optional) The folder to search for files; defaults to the current directory if not provided.
-
shell::fzf_send_telegram_attachment [-n] <token> <chat_id> <description> [folder_path]
-