GithubHelp home page GithubHelp logo

k's Introduction

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

Repository git status

Git status on files within a working tree

Repository work tree git status

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

File weight colours

Rotting dates

Dates fade with age.

Rotting dates

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 [email protected]: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.

k's People

Contributors

alankyshum avatar alh84001 avatar chrstphrknwtn avatar g0xa52a2a avatar hoelzro avatar icylace avatar jonathanbarratt avatar jozefizso avatar lejeunerenard avatar mattboll avatar philpennock avatar reduxionist avatar salmanulfarzy avatar srijanshetty avatar supercrabtree avatar unixorn avatar zblach avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.