https://github.com/supercrabtree/k
k is the new l, yo
https://github.com/supercrabtree/k
Last synced: 6 months ago
JSON representation
k is the new l, yo
- Host: GitHub
- URL: https://github.com/supercrabtree/k
- Owner: supercrabtree
- Created: 2014-03-05T00:53:47.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2023-02-04T05:43:53.000Z (over 2 years ago)
- Last Synced: 2025-03-31T20:11:31.986Z (7 months ago)
- Language: Shell
- Size: 7.18 MB
- Stars: 1,792
- Watchers: 24
- Forks: 126
- Open Issues: 37
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
- awesome-shell - k - k is a Zsh script to make directory listings more readable, adding Git status, fileweight colors and rotting dates (Command-Line Productivity)
- awesome-starred - supercrabtree/k - k is the new l, yo (others)
- jimsghstars - supercrabtree/k - k is the new l, yo (Shell)
- fucking-awesome-shell - k - k is a Zsh script to make directory listings more readable, adding Git status, fileweight colors and rotting dates (Command-Line Productivity)
- fucking-awesome-shell - k - k is a Zsh script to make directory listings more readable, adding Git status, fileweight colors and rotting dates (Command-Line Productivity)
README
[](http://k.supercrabtree.com)
> k is the new l, yo
## Directory listings for zsh with git features
**k** is a zsh script / plugin to make directory listings more readable, adding a bit of color and some git status information on files and directories.
### Git status on entire repos
### Git status on files within a working tree
### File weight colours
Files sizes are graded from green for small (< 1k), to red for huge (> 1mb).
**Human readable files sizes**
Human readable files sizes can be shown by using the `-h` flag, which requires the `numfmt` command to be available. OS X / Darwin does not have a `numfmt` command by default, so GNU coreutils needs to be installed, which provides `gnumfmt` that `k` will also use if available. GNU coreutils can be installed on OS X with [homebrew](http://brew.sh):
```
brew install coreutils
```
### Rotting dates
Dates fade with age.
## Installation
### Using [zplug](https://github.com/b4b4r07/zplug)
Load k as a plugin in your `.zshrc`
```shell
zplug "supercrabtree/k"
```
### Using [zgen](https://github.com/tarjoilija/zgen)
Include the load command in your `.zshrc`
```shell
zgen load supercrabtree/k
zgen save
```
### Using [Antigen](https://github.com/zsh-users/antigen)
Bundle k in your `.zshrc`
```shell
antigen bundle supercrabtree/k
antigen apply
```
### As an [Oh My ZSH!](https://github.com/robbyrussell/oh-my-zsh) custom plugin
Clone k into your custom plugins repo
```shell
git clone https://github.com/supercrabtree/k $ZSH_CUSTOM/plugins/k
```
Then load as a plugin in your `.zshrc`
```shell
plugins+=(k)
```
### Manually
Clone this repository somewhere (~/k for example)
```shell
git clone git@github.com:supercrabtree/k.git $HOME/k
```
Source the script
```shell
source $HOME/k/k.sh
```
Put the same line in your `.zshrc` to have `k` available whenever you start a shell. If you don't know what your `.zshrc` is, just do this.
```shell
print "source $HOME/k/k.sh" >> $HOME/.zshrc
```
## Usage
Hit k in your shell
```shell
k
```
# 😮
## Minimum Requirements
zsh 4.3.11
Git 1.7.2
## Contributors
[supercrabtree](https://github.com/supercrabtree)
[chrstphrknwtn](https://github.com/chrstphrknwtn)
[zirrostig](https://github.com/zirrostig)
[lejeunerenard](https://github.com/lejeunerenard)
[jozefizso](https://github.com/jozefizso)
[unixorn](https://github.com/unixorn)
[george-b](https://github.com/george-b)
[philpennock](https://github.com/philpennock)
[hoelzro](https://github.com/hoelzro)
[srijanshetty](https://github.com/srijanshetty)
[zblach](https://github.com/zblach)
[mattboll](https://github.com/mattboll)
Pull requests welcome :smile:
## Thanks
[Paul Falstad](http://www.falstad.com/) for zsh
[Sindre Sorhus](https://github.com/sindresorhus) for the fast git commands from zsh pure theme
[Rupa](https://github.com/rupa/z) for that slammin' strapline
Copyright © 2015 George Crabtree & Christopher Newton. MIT License.