LSX

  
  Description  
     
  Features  
     
  Installation  
     
  Usage  
     
  Demo  
     
  Feedback  
     
  Contributing  
     
  License  
  

Description

Imagine ls command, but better

Features

• Lists files and directories
• Option to group directories before or after other files
• Options to show:
  • Permissions
  • Owner
  • Size
  • Date modified
  • Total entries count
• Option to enable table view instead of classic list view
• Option to print colorful output
• Option to print icons next to entry names (Nerd Font)
• Option to print output as JSON object

Installation

If you use Arch Linux, choose one of these installation methods (note that the AUR package is ls-x, not lsx):

• Install from AUR using yay helper

  yay -S ls-x

• Install from AUR without using yay helper:

  git clone https://aur.archlinux.org/ls-x.git && cd ls-x/ && makepkg -si

If you use some other OS, choose one of these installation methods:

• git clone the repository and launch installer script

  git clone https://github.com/desyatkoff/lsx.git && cd lsx/ && bash ./install.sh

• curl the installer script

  bash <(curl -fsSL https://raw.githubusercontent.com/desyatkoff/lsx/main/install.sh)

Usage

Here is the basic usage guide:

• Do not ignore entries starting with .

  lsx --all

• List directories before other files

  lsx --group-directories-first

• List directories after other files

  lsx --group-directories-last

• Enable every --show-* option below

  lsx --show-all-columns

• Show entry permissions column

  lsx --show-permissions

• Show entry owner column

  lsx --show-owner

• Show entry size column

  lsx --show-size

• Show entry date modified column

  lsx --show-date-modified

• Show total entries count

  lsx --show-total

• Colorize output

  lsx --colors

• Use Nerd Font icons

  lsx --icons

• Use table view

  lsx --table

• JSON output

  lsx --json

• Print help

  lsx --help

• Print version

  lsx --version

It is highly recommended to make an alias for LSX in your shell configuration file so you don't have to type your favorite options every type. For me, it's alias lsx="lsx --all --group-directories-first --show-all-columns --colors --icons --table", with this line in my ~/.zshrc I can just type lsx instead of the long command with all the options!

Demo

Feedback

Found a bug? Open an issue

Want to request a feature? Start a discussion

Contributing

Refer to CONTRIBUTING.md

License

Copyright (C) Sergey Desyatkov

LSX is licensed under the GNU General Public License v3.0 or later. See the LICENSE file for more details