Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lingtalfi/k
K get kool aliases (and more) working with a simple one-liner.
https://github.com/lingtalfi/k
Last synced: about 2 months ago
JSON representation
K get kool aliases (and more) working with a simple one-liner.
- Host: GitHub
- URL: https://github.com/lingtalfi/k
- Owner: lingtalfi
- Created: 2016-02-05T23:48:15.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-02-09T18:46:07.000Z (almost 9 years ago)
- Last Synced: 2024-08-01T05:24:11.102Z (5 months ago)
- Language: Shell
- Homepage:
- Size: 27.3 KB
- Stars: 20
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-shell - k alias - get kool aliases (and more) working with a simple one-liner (Command-Line Productivity)
README
K
==========
2016-02-06
K get kool aliases (and more) working with a simple one-liner.
Features
----------
- install with one line from the web
- automatically re-organize your .bashrc in 4 files: aliases, functions, environment and sources
- creating new aliases is easy
- creating new functions is easy
- adding new environment variables is easy
- adding new sources is easy
- since 1.1.0, ships with [bashmarks](https://github.com/huyng/bashmarks)
That's it.
How to use
---------------
Go to your home directory, then call the install url below
```bash
cd
source <(curl -s https://raw.githubusercontent.com/lingtalfi/k/master/script/k_installer.sh)
```
To see what this does, see the "k structure" section below.
Note: If you need to, there are other ways/options for the installer, see the installer section below.
Then, to edit/create an alias:
```bash
kalias
```
Once edited, source it by adding the s (for source) to the kalias command.
```bash
kaliass
```
This also works for functions, environment variables and sources.
```bash
# functions
kfunc
kfuncs
# environment variables
kenv
kenvs
# sources
ksource
ksources
```
You might ask what is source used for.
K use the term source for files that you want to source right off the bat, as you login.
For instance, I personally use a framework to bookmark the location where
I go, called [bashmarks](https://github.com/huyng/bashmarks).
To configure it, I can edit the source file (using the ksource alias), and then put the following
content in it:
```bash
. /home/ling/bin/bashmarks.sh
```
But note that since 1.1.0, bashmarks is automatically included (see next section).
As a bonus, there a few aliases for web standard programs that I use.
### bashmarks
Since 1.1.0, you also have bashmarks shortcuts right away.
Please refer to the [bashmarks documentation](https://github.com/huyng/bashmarks) for more details.
In a nutshell, here is a quick memo:
- l: list
- s $name: save current dir as $name
- g $name: cd to dir $name
- d $name: delete dir $name (from the bashmarks list)
The bashmarks puts its memory to your user's home/.sdirs file.
The k structure
--------------------
When you one-line install k, it automatically creates the following structure in the
current directory where you are (which should be your user's home directory):
```bash
- .k/
----- k_aliases.sh
----- k_functions.sh
----- k_environment_variables.sh
----- k_sources.sh
```
Then, it appends the following lines to your .bashrc (unless it's already there)
```bash
# kkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk
# ____
# ||K ||
# ||__||
# |/__\|
#
# kkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk
DIR="${BASH_SOURCE%/*}"
if [[ ! -d "$DIR" ]]; then DIR="$PWD"; fi
. "$DIR/.k/k_aliases.sh"
. "$DIR/.k/k_functions.sh"
. "$DIR/.k/k_environment_variables.sh"
. "$DIR/.k/k_sources.sh"
```
Those special files are called "k files".
They are all empty by default, except the k_aliases file, which
contains some useful aliases (see k native aliases section).
k native aliases
---------------------
```bash
#-------------------------------------
# K NATIVE ALIASES
#-------------------------------------
alias kalias='vim ~/.k/k_alias.sh'
alias kaliass='. ~/.k/k_alias.sh'
alias kfunc='vim ~/.k/k_functions.sh'
alias kfuncs='. ~/.k/k_functions.sh'
alias kenv='vim ~/.k/k_environment_variables.sh'
alias kenvs='. ~/.k/k_environment_variables.sh'
alias ksource='vim ~/.k/k_sources.sh'
alias ksources='. ~/.k/k_sources.sh'
#-------------------------------------
# MAIN PROGRAM LOGS AND SERVICE
#-------------------------------------
# the principe is to start with the first letter of the service twice,
# followed by log for error log, and alog for access log (web server only)
alias aalog='tail -f /var/log/apache2/error.log'
alias aaalog='tail -f /var/log/apache2/access.log'
alias aar='service apache2 restart'
alias nnlog='tail -f /var/log/nginx/error.log'
alias nnalog='tail -f /var/log/nginx/access.log'
alias nnr='service nginx restart'
alias sslog='tail -f /var/log/syslog'
alias hhlog='tail -f /var/log/auth.log'
```
The default editor to open files is vim, but it can be changed when you
invoke the install program (first argument).
k native functions
----------------------
```bash
mcd () { mkdir -p "$1" && cd "$1"; }
path () {
echo $PATH | tr ':' '\n' | xargs ls -ld
}
importconf () {
# todo: import ling's tmux or ling's git confs
}
```
Tips
--------
Since k installs itself wherever you currently are, a good tip that you can use if you want to create all your users
with a default k skin is to cd to /etc/skel, and then call the k installer.
Here is an example:
```bash
# (be root)
cd /etc/skel
source <(curl -s https://raw.githubusercontent.com/lingtalfi/k/master/script/k_installer.sh)
```
Now, the next time you create an user, she will have the k skin right off the bat.
Ideas
---------
Create a native function that copies the k dir to another user's home directory (and configure the .bashrc)
Installer
--------------
The installer is simply a bash script that does the installation of the k program.
Although it doesn't require parameters, it the installer accepts a maximum of two parameters.
- the first argument is the editor used to open the files (some of the k native aliases use this editor).
The default is vim, but you can change it to anything you like: *nano* for instance,
or even the mac specific *open* command.
Have a look at the examples below.
- The second argument decide whether or not the installer should override your existing configuration.
By default, the installer checks for the existence of the **.k** directory in the current directory.
If the .k directory exists, the installer does nothing.
This is generally what we want.
However, it is possible to tell the installer to override your current .k directory, no matter what.
To do so, you use the second argument, called **override** and set its value to 1.
Generally, this is a bad idea, but I added it for personal purposes (details are not very interesting),
and I wanted you to be aware of it.
Here are different ways to call the installer, some examples use wget, some other use curl.
```bash
# default example
source <(curl -s https://raw.githubusercontent.com/lingtalfi/k/master/script/k_installer.sh)
# alternative using nano as the default editor instead of vim
curl -s https://raw.githubusercontent.com/lingtalfi/k/master/script/k_installer.sh | bash /dev/stdin nano
# alternative using open (mac) as the default editor instead of vim
curl -s https://raw.githubusercontent.com/lingtalfi/k/master/script/k_installer.sh | bash /dev/stdin open
# wget alternative
bash <(wget -qO- https://raw.githubusercontent.com/lingtalfi/k/master/script/k_installer.sh)
# wget alternative using nano as the default editor instead of vim
wget -qO- https://raw.githubusercontent.com/lingtalfi/k/master/script/k_installer.sh | bash -s -- nano
```
History Log
------------------
- 1.2.2 -- 2016-02-07
- add nnconf alias to edit nginx.conf
- 1.2.1 -- 2016-02-06
- add ffconf alias to edit php-fpm www.conf
- 1.2.0 -- 2016-02-06
- add php-fpm aliases
- add override mechanism to force re-install
- 1.1.0 -- 2016-02-06
- add bashmarks to the default install
- 1.0.0 -- 2016-02-06
- initial commit