ryochack / peep Goto Github PK

The CLI text viewer tool that works like less command on small pane within the terminal window.

License: MIT License

Rust 100.00%

pager less cat cli cli-text-viewer more text

peep's Introduction

peep

peep is the CLI text viewer tool.
This tool works interactively like less command on small pane within the terminal window.
And leave the output on the terminal when quit like cat command.

Demos

Pane on Terminal Window

peep can view text file freely.

Read from Pipe

Print Line Number

Resize Pane

Incremental Regex Search

Wide Width Character Support

Follow Mode

peep has the follow mode that can monitor file updates and read them continuously like tail -f or less +F.
Also, peep can switch between the normal mode and follow mode with F command.

Highlighting on Follow Mode

peep can highlight the regex word on the follow mode.

Text Line Wrapping

Installation

cargo install peep

If you don't have Rust toolchains, please refer to The Rust Programming Language.

Or, you can download peep binary file from GitHub peep Releases :)

Usage

peep [OPTION]... [FILE]

Options

-n, --lines LINES        set height of pane
-s, --start START        set start line of data at startup
-t, --tab-width WIDTH    set tab width
-N, --print-line-number  print line numbers
-f, --follow             output appended data as the file grows
-h, --help               show this usage
-v, --version            show version

Commands

Format

KEY-BIND            OPERATION

Example 1

0 Ctr-a             Go to the beggining of line

Type 0 OR Ctrl-a, then Go to the beggining of line.

Example 2

(num)+              Increment screen height

(num) means that entering a number is optional.
If you omit the number input, the number will be processed as 1.

Example 3

[num]=              Set screen height to [num]

[num] means that entering a number is mandatory.

Commands on Normal Mode

(num)j Ctr-j Ctr-n  Scroll down
(num)k Ctr-k Ctr-p  Scroll up
(num)d Ctr-d        Scroll down half page
(num)u Ctr-u        Scroll up half page
(num)f Ctr-f SPACE  Scroll down a page
(num)b Ctr-b        Scroll up a page
(num)l              Scroll horizontally right
(num)h              Scroll horizontally left
(num)L              Scroll horizontally right half page
(num)H              Scroll horizontally left half page
0 Ctr-a             Go to the beggining of line
$ Ctr-e             Go to the end of line
g                   Go to the beggining of file
G                   Go to the end of file
[num]g [num]G       Go to line [num]
/pattern            Search forward in the file for the regex pattern
n                   Search next
N                   Search previous
q Ctr-c             Quit
Q                   Quit with clearing pane
(num)+              Increment screen height
(num)-              Decrement screen height
[num]=              Set screen height to [num]
#                   Toggle line number printing
!                   Toggle line wrapping
ESC                 Cancel
F                   Toggle to follow mode

Commands on Follow Mode

/pattern            Highlight the regex pattern
q Ctr-c             Quit
(num)+              Increment screen height
(num)-              Decrement screen height
[num]=              Set screen height to [num]
#                   Toggle line number printing
!                   Toggle line wrapping
ESC                 Cancel
F                   Toggle to normal mode

Supported Platforms

Linux
MacOS

License

MIT License. Please refer to LICENSE file.

peep's People

Contributors

Stargazers

Watchers

Forkers

ryota-sakamoto mic92 moredread dlee13 klimit

peep's Issues

Feature: Support clearing peep output on exit

By default, when less exits, the text it was displaying is cleared and the user's terminal window is returned to the state it was in prior to less being invoked.

I think this is a vital feature of less, and of short-lived interactive CLI utilities in general (programs like fzf, bat, etc. also implement this feature).

Peep's selling point seems to be its focus on not displacing the surrounding terminal context; I think that the functionality I just described would be very complementary to this focus.

As a workaround, I wrote a little wrapper script which basically accomplishes this (requires ncurses):

#!/bin/bash
set -euo pipefail

function isset_help() {
  local opt
  for opt in "$@"; do
    case "$opt" in
      --)
        echo 0
        return 0
        ;;
      --help)
        echo 1
        return 0
        ;;
    esac
  done

  while getopts ':h' opt "$@"; do
    case "$opt" in
      h)
        echo 1
        return 0
        ;;
      *)
        continue
        ;;
    esac
  done

  echo 0
  return 0
}

function main() {
  local -i h
  h=$(isset_help "$@")
  [[ $h -eq 0 ]] && tput sc
  peep "$@"
  local -i c=$?
  [[ $c -eq 0 && $h -eq 0 ]] && tput rc
  return $c
}

main "$@"

Before:

2021-01-12_23-43-44_Alacritty.mp4

After:

2021-01-12_23-47-02_Alacritty.mp4

It's far from ideal and doesn't work when the cursor line is at or within --lines of the bottom of the terminal window, but it should give you an idea of what I am proposing.

Thanks for creating this project, I really love using it!

Works on Windows Subsystem for Linux (WSL) too

Hi there,

Thanks for the nice lib. Got to try it on WSL & it seems to work fine.

hyper	Bash

In case someone else is wondering...

Cheers,
Dan

Support ansi color codes

If you could implement the support of ansi color coding that would be fantastic. Right now if I use color codes, they get printed literally:

echo -e "\x1b[38;5;208mTEST" | peep

Output:
[38;5;208mTEST

Thank you so much

Fix Inappropriate ioctl for device

標準アウトプットはTTYじゃないとき、パニックしてしまいます。もっとましなエラーメッセージがでたらいいなと思います。なお、TTYじゃない場合は初期設定のサイズのウィンドウで出力を出して終了するのもありかなと思ったりしますが、いかがでしょうか。

peep Hello.txt | cat
thread 'main' panicked at 'terminal_size get error: Os { code: 25, kind: Other, message: "Inappropriate ioctl for device" }', src/libcore/result.rs:999:5
stack backtrace:
   0: std::panicking::default_hook::{{closure}}
   1: std::panicking::default_hook
   2: std::panicking::rust_panic_with_hook
   3: std::panicking::continue_panic_fmt
   4: rust_begin_unwind
   5: core::panicking::panic_fmt
   6: core::result::unwrap_failed
   7: peep::pane::Pane::new
   8: peep::app::App::run
   9: peep::main
  10: std::rt::lang_start::{{closure}}
  11: std::panicking::try::do_call
  12: __rust_maybe_catch_panic
  13: std::rt::lang_start_internal
  14: main

$ cargo run -- -n 4 Cargo.toml > out.txt
$ vim out.txt
�[1G�[2K
lines�[2K
lines�[2K
lines�[2K
lines�[2K�[4F [package]�[m
 name = "peep"�[m
 edition = "2018"�[m
 version = "0.1.4"�[m

So, I will add raw-output-mode to peep to fix it.

New release?

Support moving with arrows, PageUp, PageDown, …

Could you please consider adding the following alternative key bindings?

DownArrow   Scroll down
UpArrow     Scroll up
PageDown    Scroll down a page
PageUp      Scroll up a page
RightArrow  Scroll horizontally right
LeftArrow   Scroll horizontally left
Home        Go to the beggining of line
End         Go to the end of line

Add a command to open the file in $EDITOR

Can you please add a command to open the file in the default editor ($EDITOR)? Preferably bind to the e key.