readme.md

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:

brew install coreutils

Rotting dates

Dates fade with age.

Installation

Using zplug

Load k as a plugin in your .zshrc

zplug "supercrabtree/k"

Using zgen

Include the load command in your .zshrc

zgen load supercrabtree/k
zgen save

Using Antigen

Bundle k in your .zshrc

antigen bundle supercrabtree/k
antigen apply

As an Oh My ZSH! custom plugin

Clone k into your custom plugins repo

git clone https://github.com/supercrabtree/k $ZSH_CUSTOM/plugins/k

Then load as a plugin in your .zshrc

plugins+=(k)

Manually

Clone this repository somewhere (~/k for example)

git clone git@github.com:supercrabtree/k.git $HOME/k

Source the script

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.

print "source $HOME/k/k.sh" >> $HOME/.zshrc

Usage

Hit k in your shell

k

😮

Minimum Requirements

zsh 4.3.11
Git 1.7.2

Contributors

supercrabtree
chrstphrknwtn
zirrostig
lejeunerenard
jozefizso
unixorn
george-b
philpennock
hoelzro
srijanshetty
zblach
mattboll
Pull requests welcome 😄

Thanks

Paul Falstad for zsh
Sindre Sorhus for the fast git commands from zsh pure theme
Rupa for that slammin' strapline

Copyright © 2015 George Crabtree & Christopher Newton. MIT License.