Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gto76/standard-aliases

Attempt at defining a standard extension to Linux in form of Bash functions
https://github.com/gto76/standard-aliases

bash bash-alias bashrc dotfiles

Last synced: about 2 months ago
JSON representation

Attempt at defining a standard extension to Linux in form of Bash functions

Host: GitHub
URL: https://github.com/gto76/standard-aliases
Owner: gto76
License: mit
Created: 2015-07-19T01:47:59.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2024-03-08T22:24:46.000Z (10 months ago)
Last Synced: 2024-10-14T16:39:07.239Z (2 months ago)
Topics: bash, bash-alias, bashrc, dotfiles
Language: Shell
Homepage:
Size: 819 KB
Stars: 109
Watchers: 6
Forks: 18
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        
![Standard Aliases](doc/sa_logo.png)

### Make Linux more user friendly with this collection of **Bash functions**!

They provide **commands that should be in Linux** by default, or just **abbreviations of commands** that are provided, but are so commonly used that they deserve a shorter name and/or a set of configurable **“sensible” options**. When abbreviated command is executed, these predefined options are combined with the actual ones. Also most of the commands send their **output to a pager** if it doesn't fit the screen.

Collection was made for **Debian** based Linux (**Ubuntu**, **Mint**, ...) with **Gnome** desktop environment, but most commands will work on any system that has _Bash_ shell and _GNU Coreutils_ installed. For **macOS** see [instructions](#how-to-run-on-macos).

There are currently **211 commands**.

How to…

-------

### Install

```

$ git clone https://github.com/gto76/standard-aliases

$ cd standard-aliases

$ ./install

```

### Uninstall

```

$ ./uninstall

```

Commands

--------

Below is a list of most useful commands. If you want to check out the full list see [**LIST OF ALL COMMANDS**](doc/FUNCTION_DESCRIPTIONS.md).

####  Basic 

 _Name_        | _Runs_   | _Description_  

:------------- |:--------:| ----------------

**p** | if [[ $# -eq 0 [**`...`**](standard_functions#L439-L445) | Print working directory or path to file.

**l** | ___displayOutpu[**`...`**](standard_functions#L194-L197) | List or display directory contents in pager using short listing format.

**la** | __listOrDisplay[**`...`**](standard_functions#L209-L212) | List or display all directory contents in pager using short listing format.

**ll** | ___displayOutpu[**`...`**](standard_functions#L204-L207) | List or display directory contents in pager using long listing format.

**lla** | __listOrDisplay[**`...`**](standard_functions#L219-L222) | List or display all directory contents in pager using long listing format.

**e** | echo "$@" | Print text.

**c** | cat "$@" | Print file contents.

**m** | ___printOrDispl[**`...`**](standard_functions#L92-L94) | Print or display text or file in pager.

**v** | vim -p "$@" | Edit file with vim.

####  Directories 

 _Name_        | _Runs_   | _Description_  

:------------- |:--------:| ----------------

**mk, md, mkdir1** | mkdir --parents[**`...`**](standard_functions#L413-L416) | Create directory and descend into.

**cpdir** | cp --interactiv[**`...`**](standard_functions#L394-L396) | Copy directories safely.

**mvdir** | mv --interactiv[**`...`**](standard_functions#L400-L402) | Move directories safely.

**rmdir** | rm --interactiv[**`...`**](standard_functions#L407-L409) | Delete directories safely.

####  Useful 

 _Name_        | _Runs_   | _Description_  

:------------- |:--------:| ----------------

**extract** | if [ -z "$1" ];[**`...`**](standard_functions#L1127-L1160) | Extract archive of any type.

**o, openFile** | __runCommandInB[**`...`**](standard_functions#L585-L587) | Open file with default app.

**rb, runInBackground** | nohup "$@" &>/d[**`...`**](standard_functions#L474-L476) | Run command in background.

**me, makeExecutable** | if [[ ! -f "$1"[**`...`**](standard_functions#L635-L683) | Make file executable or create new bash or python script.

**lo, locate1** | locate  "$1" \[**`...`**](standard_functions#L1103-L1107) | Locate files on filesystem containing pattern in their names.

**grr** | __printLinesCon[**`...`**](standard_functions#L1092-L1098) | Print or display with pager numbered lines containing pattern in working and subdirectories.

####  Git 

 _Name_        | _Runs_   | _Description_  

:------------- |:--------:| ----------------

**gs** | git -c color.st[**`...`**](standard_functions#L1646-L1649) | Print short repository status.

**gd** | git diff "$@" | Display changes between commits.

**gl** | git log --graph[**`...`**](standard_functions#L1653-L1655) | Display minimal log of commits.

**commit** | git commit -am [**`...`**](standard_functions#L1603-L1605) | Commit changed and deleted files with message.

**push** | git push "$@" | Push changes to remote repository.

**pull** | git pull "$@" | Pull changes from remote repository.

####  Networking 

 _Name_        | _Runs_   | _Description_  

:------------- |:--------:| ----------------

**pa, pingAll** | ping -c 1 -q $([**`...`**](standard_functions#L1767-L1771) | Ping gateway and google.

**ip1** | /sbin/ifconfig [**`...`**](standard_functions#L1739-L1746) | Print internal ip.

**ip2** | lynx --dump htt[**`...`**](standard_functions#L1749-L1751) | Print external ip.

**gateway** | route -n \[**`...`**](standard_functions#L1754-L1759) | Print gateways ip.

####  Packages 

 _Name_        | _Runs_   | _Description_  

:------------- |:--------:| ----------------

**update** | sudo apt-get up[**`...`**](standard_functions#L1356-L1358) | Update information about available packages.

**ch, canhaz** | if [[ "$__stand[**`...`**](standard_functions#L1347-L1353) | Install package.

**ve, version** | # Check if pass[**`...`**](standard_functions#L1442-L1459) | Print installed and available version of package or command.

**wi, whatis1** | # Checks if it [**`...`**](standard_functions#L1570-L1594) | Describe package or command or find available packages with part of name or command.

How To Rename Commands

----------------------

* Check if name is already taken by running: `$ type `

* Open **`.standardrc`** located in your home directory and add a new name in front of function's description.

* Save and run: `$ bash`

Misc

----

* Usually if function only makes Linux command easier to use, either by using a few “sensible” options, or just by sending output to a pager (if necessary), then it has the same name as command, but with number `1` appended at the end. Some examples are: `ps1`, `mkdir1`, `pgrep1`, `tree1`. Options for this commands are defined at the bottom of [`standardrc`](standard_rc#L328-L358) and can be customized by preference.

* **`cp`**, **`mv`**, **`rm`** and **`rmdir`** are the only functions that override already existing commands. They are all run in interactive mode, meaning you get asked for conformation before any destructive operation. If you want to execute them without this prompting, use `-f` (force) option. `rmdir` also deletes the directory contents.

* Command-line completions are automatically assigned to functions, depending on what commands they use.

* Commands for accessing the “framework”:

  * **`ty COMMAND`** – prints function's body (short for `type`),

  * **`rc`** – opens configuration file (`~/.standardrc`) in default editor,

  * **`fu`** – opens `standard_functions` in default editor.

How It Works

------------

After installation the “framework” consists of three files:

* [**`standard_functions`**](standard_functions): It contains _Bash_ functions with long descriptive names. It is located in projects directory.

* User's [**`.standardrc`**](standard_rc) file: Configuration file that specifies short names for functions.  Also defines [options](standard_rc#L328-L358) that this functions use when they call specific commands. It is located in user's home directory.

* Automatically generated **`aliases`** file: Contains functions with short names that call functions with longer names (as defined in configuration file). It also assigns appropriate command-line completions to the short functions. It is located in `~/.standard_aliases` directory.

Every time new _Bash_ shell is started, "framework" checks if any changes were made to the functions or configuration file and if so, it generates new `aliases` file.

How to run on macOS

-------------------

* Install _Developer Tools_ by running:

```

make

```

* Install _Homebrew_:

```

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

```

* Install _GNU Coreutils_:

```

brew install coreutils

echo '. .bashrc' >> .profile

echo 'PATH="/usr/local/opt/coreutils/libexec/gnubin:$PATH"' >> ~/.bashrc

bash

```

* Install other _GNU_ programs (optional):

```

brew tap homebrew/dupes

brew install grep --with-default-names

brew install findutils --with-default-names

brew install tree

...

```