Skip to content

Commit

Permalink
feat(dotfiles): 🔧 Added enhanced shell aliases with improved document…
Browse files Browse the repository at this point in the history
…ation and organisation

- Added metadata header with script details (name, version, author, etc.) - Documented each alias with a brief comment explaining its purpose - Grouped aliases into logical sections (general, exit/shutdown, network, etc.) - Included additional commonly used aliases for enhanced shell usage - Ensured compatibility with both Linux and macOS platforms - Encapsulated aliases within a function to prevent global namespace pollution - Improved overall readability, completeness, and maintainability of the script
  • Loading branch information
sebastienrousseau committed Feb 19, 2024
1 parent 6dec557 commit 0cd7105
Showing 1 changed file with 93 additions and 85 deletions.
178 changes: 93 additions & 85 deletions lib/aliases/default/default.aliases.sh
Original file line number Diff line number Diff line change
@@ -1,123 +1,131 @@
#!/usr/bin/env bash

# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.468) - <https://dotfiles.io>
# Made with ♥ in London, UK by @wwdseb
# Copyright (c) 2015-2024. All rights reserved
# License: MIT
################################################################################
# 🅳🅾🆃🅵🅸🅻🅴🆂
# Script: default.aliases.sh
# Version: 0.2.468
# Author: @wwdseb
# Copyright (c) 2015-2024. All rights reserved
# Description: Script containing default shell aliases
# Website: https://dotfiles.io
# License: MIT
################################################################################

# 🅳🅴🅵🅰🆄🅻🆃 🅰🅻🅸🅰🆂🅴🆂

## General aliases

# Shortcut for the `clear` command.
alias c="clear"

# Display the current date and time.
alias da='date "+%Y-%m-%d %A %T %Z"'

# Shortcut for `pwd` which returns working directory name.
alias p='pwd'

# Display the $PATH variable on newlines.
alias path='echo ${PATH//:/\\n}'

# Reload the shell.
alias r='reload'
# Function: set_default_aliases
#
# Description:
# Sets default shell aliases for enhanced shell usage.
#
# Arguments:
# None
#
# Notes:
# - Some aliases are designed for enhanced shell navigation and utility.
# - Ensure to validate that all aliases work as expected in the bash shell.

# Prints the last 10 lines of a text or log file, and then waits for new
# additions to the file to print it in real time.
alias t='tail -f'
set_default_aliases() {
## General aliases
# Shortcut for the `clear` command.
alias c="clear"

# wk: Show the current week number.
alias wk='date +%V'
# Display the current date and time.
alias da='date "+%Y-%m-%d %A %T %Z"'

## Exit/shutdown aliases
# Shortcut for `pwd` which returns working directory name.
alias p='pwd'

# Shortcut for the `exit` command.
alias ':q'='quit'
# Display the $PATH variable on newlines.
alias path='echo ${PATH//:/\\n}'

# Shortcut for the `exit` command.
alias bye='quit'
# Reload the shell.
alias r='reload'

# Shortcut for the `exit` command.
alias q='quit'
# Prints the last 10 lines of a text or log file, and then waits for new
# additions to the file to print it in real time.
alias t='tail -f'

# Shortcut for the `exit` command.
alias x='quit'
# Show the current week number.
alias wk='date +%V'

# Shortcut for the `exit` command.
alias quit='exit'
## Exit/shutdown aliases
# Shortcut for the `exit` command.
alias ':q'='quit'

# Shutdown the system.
alias halt='sudo /sbin/halt'
# Shortcut for the `exit` command.
alias bye='quit'

# Poweroff the system.
alias poweroff='sudo /sbin/shutdown'
# Shortcut for the `exit` command.
alias q='quit'

# Reboot the system.
alias reboot='sudo /sbin/reboot'
# Shortcut for the `exit` command.
alias x='quit'

## Network aliases
# Shortcut for the `exit` command.
alias quit='exit'

# Append sudo to ifconfig (configure network interface parameters)
# command.
alias ifconfig='sudo ifconfig'
# Shutdown the system.
alias halt='sudo /sbin/halt'

# Get network interface parameters for en0.
alias ipinfo='ipconfig getpacket en0'
# Poweroff the system.
alias poweroff='sudo /sbin/shutdown'

# Show only active network listeners.
alias nls='sudo lsof -i -P | grep LISTEN'
# Reboot the system.
alias reboot='sudo /sbin/reboot'

# List of open ports.
alias op='sudo lsof -i -P'
## Network aliases
# Append sudo to ifconfig (configure network interface parameters)
# command.
alias ifconfig='sudo ifconfig'

# Limit Ping to 5 ECHO_REQUEST packets.
alias ping='ping -c 5'
# Get network interface parameters for en0.
alias ipinfo='ipconfig getpacket en0'

# List all listening ports.
alias ports='netstat -tulan'
# Show only active network listeners.
alias nls='sudo lsof -i -P | grep LISTEN'

# Start a simple HTTP server.
alias srv='python3 -m http.server'
# List of open ports.
alias op='sudo lsof -i -P'

## System monitoring aliases
# Limit Ping to 5 ECHO_REQUEST packets.
alias ping='ping -c 5'

# Get the moon phase.
alias moon='curl -s "wttr.in/?format=%m"'
# List all listening ports.
alias ports='netstat -tulan'

# Allows the user to interactively monitor the system's vital resources
# or server's processes in real time.
alias top='sudo btop'
# Start a simple HTTP server to serve the current directory on port 8000.
alias srv='python3 -m http.server 8000 --bind 127.0.0.1'

# Remove all log files in /private/var/log/asl/.
alias spd='sudo rm -rf /private/var/log/asl/*'
## System monitoring aliases
# Allows the user to interactively monitor the system's vital resources
# or server's processes in real time.
alias top='sudo btop'

## Utility aliases
# Remove all log files in /private/var/log/asl/.
alias spd='sudo rm -rf /private/var/log/asl/*'

# Count the number of files in the current directory.
alias ctf='echo $(ls -1 | wc -l)'
## Utility aliases
# Count the number of files in the current directory.
alias ctf='echo $(ls -1 | wc -l)'

# Use compression when transferring data.
alias curl='curl --compressed'
# Use compression when transferring data.
alias curl='curl --compressed'

# Quickly search for file.
alias qfind='find . -name '
# Quickly search for file.
alias qfind='find . -name '

# Reload the shell.
alias reload='exec $SHELL -l'
# Reload the shell.
alias reload='exec $SHELL -l'

# Get the weather.
alias wth='curl -s "wttr.in/?format=3"'
# Get the weather.
alias wth='curl -s "wttr.in/?format=3"'

# File system navigation aliases
## File system navigation aliases
# Clear the terminal screen and print the contents of the current
# directory.
alias clc='clear && ls -a'

# Clear the terminal screen and print the contents of the current
# directory.
alias clc='clear && ls -a'
# Clear the terminal screen and print
alias clp='pwd'
}

# Clear the terminal screen and print
alias clp='pwd'
set_default_aliases

0 comments on commit 0cd7105

Please sign in to comment.