ls-Improved 0.5.1

show directory description when ls.

ls-Improved: descriptive ls-like-command working on Python

日本語README

What is it?

ls-Improved (lsi) prints out a directory structure with its descriptions. I've been using it when tackling some seriese of experiments.(e.g. machine leaning experiments.)

Example

We have some directories like below.
Sometimes we'd like to access the best result of experiments, but it is not easy. It is necessary to open all of directories or note experiments_summary.txt beforehand in order to do it.

Now we have the ls-Improved(lsi) command here. It allows us to see list of directories with its descriptions simultaneously.

Requirements

developed on Python2.7 and Python3.7 (maybe ≧Python2.7 is ok.)
It is working on Python, so this command dose not depend on OS.

Install

pip install

# PyPI
pip install ls-Improved

manual install

For person who do not like PyPI, manual install version exists.

1. download latest manual version from github release.
   wget https://github.com/ShotaroKataoka/ls-Improved/archive/v0.3.0.beta1.manual.zip
2. unzip downloaded zip file.
3. set PATH environment to bin/ directory.
   (set PATH to unziped bin/ directory or place bin/lsi and bin/mkdiri to /usr/local/bin/ )

Usage

How works

lsi read .description.lsi files which are in each directories.
.description.lsi is simple text file. It is made by mkdiri command.

In brief:

• mkdiri make a directory with the .description.lsi text file.
• lsi print out directory structure with .description.lsi content.

mkdiri

mkdiri make a directory with the .description.lsi.

• mkdiri DIRECTORY 'DESCRIPTION' : make DIRECTORY and write DESCRIPTION into .description.lsi
• mkdiri DIRECTORY : make DIRECTORY and create empty .description.lsi
• mkdiri -f FILE-PATH 'DESCRIPTION' : write FILE-PATH's DESCRIPTION into .file_description.lsi
• mkdiri -a DIRECTORY 'DESCRIPTION' : overwrite or create .description.lsi in existing directory.
• mkdiri -h : Show help

Advanced feature ( !! these commands create ~/.lsirc !! ):

• mkdiri -e : Show current mkdiri mode. (LSI MODE or ANSI MODE)
• mkdiri --ANSI-MODE : Set ANSI-ESCAPE-SEQUENCE MODE. (convert decoration to ANSI escape sequence)
• mkdiri --LSI-MODE : Set LSI-ESCAPE-SEQUENCE MODE. (default)

tips:
Add decoration to description :

• \n : make new line
• ;r; ;g; ;b; ;w; ;p; : add color to text
• ;_; : add underline to text
• ;e; : end decoration

Example

lsi

lsi print out directory structure with .description.lsi content.

• lsi : Show directory structure and these descriptions in the current directory
• lsi DIRECTORY : Show directory structure and these descriptions in the DIRECTORY
• lsi -a : Show hidden files and directories
• lsi -f : Show only files
• lsi -d : Show only directories
• lsi -s 'SEARCH_WORD' : search file-name and description with SEARCH_WORD
• lsi -n NUMBER: Raise warning if number of files is bigger than NUMBER.
• lsi -h : Show help

tips:
Adding following alias to .bashrc is useful :

alias clear='clear && lsi ././'
function cdlsi (){
    /cd $@ && lsi ././
}
alias cd='cdlsi'

Related projects

• Emacs client by conao3