#cat #cli #clone #line-numbers

app elk

elk - a cat alternative written in rust

2 releases

0.3.1 Jun 23, 2021
0.3.0 Jun 23, 2021

#46 in #line-numbers

Custom license

22KB
370 lines

elk

elk - a powerful cat alternative written in rust

elk is a replacement for the 'cat' command

elks features include

  • Print line numbers
  • Print $ at EOL
  • Print statistics (count of lines, characters and uni-characters, size of file) at the end of the file
  • Print a specified range of lines

Usage

elk [FLAGS] [OPTIONS] <path>

FLAGS:
    -h, --help            Prints help information
    -n, --line_numbers    Print line numbers
    -q, --quiet           Do not print the file contents
    -e, --show-ends       Print $ at EOL
    -s, --statistics      Print statistics (count of lines, characters and uni-characters, actual size of file) at the end of the file
        --size            print apparent sizes, rather than disk usage
    -V, --version         Prints version information

OPTIONS:
    -l, --lines <n:m>    Print a specified range of lines [default: :]

ARGS:
    <path>    Give me a file

Installation

cargo install elk

Manual installation

install rustc and cargo

cd /tmp

git clone https://github.com/macmoritz/elk.git
cd /tmp/elk

cargo build --release

cd target/release

./elk

To install elk locally

cd /tmp/elk
cargo install --path .

and add this line to your .bashrc or .zshrc

export PATH=$PATH:$HOME/.cargo/bin

Using elk instead of cat

in .zshrc or .bashrc

alias cat='elk'

Third-Party software

Thanks to all developers

https://github.com/TeXitoi/structopt
https://github.com/mistodon/config_struct
https://github.com/serde-rs/serde
https://github.com/dtolnay/serde-yaml
https://github.com/eminence/terminal-size
https://github.com/freaky/rust-filesize
https://github.com/mackwic/colored

Dependencies

~3–14MB
~125K SLoC