https://github.com/lukasbach/piek

Peek into files from the command line
https://github.com/lukasbach/piek

cli files react tool typescript util

Last synced: about 2 months ago
JSON representation

Peek into files from the command line

• Host: GitHub
• URL: https://github.com/lukasbach/piek
• Owner: lukasbach
• Created: 2019-11-25T13:24:25.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-11-26T13:56:49.000Z (over 6 years ago)
• Last Synced: 2025-03-18T11:35:27.398Z (over 1 year ago)
• Topics: cli, files, react, tool, typescript, util
• Language: TypeScript
• Homepage:
• Size: 2.71 MB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

          
PIEK

====

Peek into any file right from your terminal. 

## Usage

Just run ``piek yourfile.txt`` from anywhere in your terminal to open the file.

Use your arrow keys (up and down) to navigate from within the file. You can also

expand/collapse the size of your view by pressing shift+up/down.

![PIEK usage demo](https://raw.githubusercontent.com/lukasbach/piek/master/demo.gif "PIEK usage demo")

## Installation

You need Node.js installed. Run ``npm i -g piek`` to install PIEK globally so you can run 

``piek filename.txt`` from anywhere in your terminal.

    $ npm i -g piek

    $ piek filename.txt

You can also run PIEK by calling ``npx piek yourfile.txt`` to skip installation and directly

run it.

    $ npx piek yourfile.txt