{"id":13683624,"url":"https://github.com/ryochack/peep","last_synced_at":"2025-04-06T12:12:18.585Z","repository":{"id":57654023,"uuid":"145991042","full_name":"ryochack/peep","owner":"ryochack","description":"The CLI text viewer tool that works like less command on small pane within the terminal window.","archived":false,"fork":false,"pushed_at":"2022-09-19T22:37:35.000Z","size":206,"stargazers_count":166,"open_issues_count":5,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-30T11:09:15.696Z","etag":null,"topics":["cat","cli","cli-text-viewer","less","more","pager","text"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ryochack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-24T12:51:24.000Z","updated_at":"2025-02-19T08:50:20.000Z","dependencies_parsed_at":"2022-09-09T09:30:57.743Z","dependency_job_id":null,"html_url":"https://github.com/ryochack/peep","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryochack%2Fpeep","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryochack%2Fpeep/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryochack%2Fpeep/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryochack%2Fpeep/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ryochack","download_url":"https://codeload.github.com/ryochack/peep/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247478325,"owners_count":20945266,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cat","cli","cli-text-viewer","less","more","pager","text"],"created_at":"2024-08-02T13:02:19.518Z","updated_at":"2025-04-06T12:12:18.561Z","avatar_url":"https://github.com/ryochack.png","language":"Rust","readme":" [![crates.io](https://img.shields.io/crates/v/peep.svg)](https://crates.io/crates/peep)\n ![test](https://github.com/ryochack/peep/workflows/test/badge.svg)\n\n# peep\npeep is the CLI text viewer tool.  \nThis tool works interactively like `less` command on small pane within the terminal window.  \nAnd leave the output on the terminal when quit like `cat` command.\n\n# Demos\n## Pane on Terminal Window\npeep can view text file freely.\n\n![Pane on Terminal Window](https://raw.githubusercontent.com/wiki/ryochack/peep/images/demo.gif)\n## Read from Pipe\n![Pipe Input](https://raw.githubusercontent.com/wiki/ryochack/peep/images/demo_pipe.gif)\n## Print Line Number\n![Print Line Number](https://raw.githubusercontent.com/wiki/ryochack/peep/images/demo_linenumber.gif)\n## Resize Pane\n![Resize Pane](https://raw.githubusercontent.com/wiki/ryochack/peep/images/demo_resize.gif)\n## Incremental Regex Search\n![Incremental Regex Search](https://raw.githubusercontent.com/wiki/ryochack/peep/images/demo_incsearch.gif)\n## Wide Width Character Support\n![Wide Width Character Support](https://raw.githubusercontent.com/wiki/ryochack/peep/images/demo_wide_width_chars.gif)\n## Follow Mode\npeep has the follow mode that can monitor file updates and read them continuously like `tail -f` or `less +F`.  \nAlso, peep can switch between the normal mode and follow mode with `F` command.\n\n![Follow Mode](https://raw.githubusercontent.com/wiki/ryochack/peep/images/demo_follow.gif)\n## Highlighting on Follow Mode\npeep can highlight the regex word on the follow mode.\n\n![Highlighting on Follow Mode](https://raw.githubusercontent.com/wiki/ryochack/peep/images/demo_follow_hl.gif)\n## Text Line Wrapping\n\n![Text Line Wrapping](https://raw.githubusercontent.com/wiki/ryochack/peep/images/demo_wrapping.gif)\n\n# Installation\n```shell\ncargo install peep\n```\n\nIf you don't have Rust toolchains, please refer to [The Rust Programming Language](https://www.rust-lang.org/).\n\nOr, you can download peep binary file from [GitHub peep Releases](https://github.com/ryochack/peep/releases) :)\n\n# Usage\n```shell\npeep [OPTION]... [FILE]\n```\n\n## Options\n```\n-n, --lines LINES        set height of pane\n-s, --start START        set start line of data at startup\n-t, --tab-width WIDTH    set tab width\n-N, --print-line-number  print line numbers\n-f, --follow             output appended data as the file grows\n-h, --help               show this usage\n-v, --version            show version\n```\n\n## Commands\n**Format**  \n\n```\nKEY-BIND            OPERATION\n```\n\n**Example 1**  \n\n```\n0 Ctr-a             Go to the beggining of line\n```\nType `0` OR `Ctrl-a`, then `Go to the beggining of line`.\n\n**Example 2**  \n\n```\n(num)+              Increment screen height\n```\n`(num)` means that entering a number is optional.  \nIf you omit the number input, the number will be processed as 1.\n\n**Example 3**  \n\n```\n[num]=              Set screen height to [num]\n```\n`[num]` means that entering a number is mandatory.\n\n\n### Commands on Normal Mode\n```\n(num)j Ctr-j Ctr-n  Scroll down\n(num)k Ctr-k Ctr-p  Scroll up\n(num)d Ctr-d        Scroll down half page\n(num)u Ctr-u        Scroll up half page\n(num)f Ctr-f SPACE  Scroll down a page\n(num)b Ctr-b        Scroll up a page\n(num)l              Scroll horizontally right\n(num)h              Scroll horizontally left\n(num)L              Scroll horizontally right half page\n(num)H              Scroll horizontally left half page\n0 Ctr-a             Go to the beggining of line\n$ Ctr-e             Go to the end of line\ng                   Go to the beggining of file\nG                   Go to the end of file\n[num]g [num]G       Go to line [num]\n/pattern            Search forward in the file for the regex pattern\nn                   Search next\nN                   Search previous\nq Ctr-c             Quit\nQ                   Quit with clearing pane\n(num)+              Increment screen height\n(num)-              Decrement screen height\n[num]=              Set screen height to [num]\n#                   Toggle line number printing\n!                   Toggle line wrapping\nESC                 Cancel\nF                   Toggle to follow mode\n```\n\n### Commands on Follow Mode\n```\n/pattern            Highlight the regex pattern\nq Ctr-c             Quit\n(num)+              Increment screen height\n(num)-              Decrement screen height\n[num]=              Set screen height to [num]\n#                   Toggle line number printing\n!                   Toggle line wrapping\nESC                 Cancel\nF                   Toggle to normal mode\n```\n\n# Supported Platforms\n- Linux\n- MacOS\n\n# License\nMIT License.\nPlease refer to LICENSE file.\n","funding_links":[],"categories":["Rust"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryochack%2Fpeep","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fryochack%2Fpeep","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryochack%2Fpeep/lists"}