k

README

This is a golang port of the excellent supercrabtree/k

Directory listings for zsh with git features

k makes 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

go install github.com/gaelph/k

Manually

Clone this repository somewhere (~/k for example)

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

Install it

cd $HOME/k

go install .

Usage

Hit k in your shell

k

😮

Minimum Requirements

Golang

Git 1.7.2

Contributors

gaelph
Pull requests welcome 😄

Thanks

supercrabtree for the original k

Documentation

Overview

Copyright © 2020 NAME HERE <EMAIL ADDRESS>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.