termex

Explore the filesystem from your terminal

Project maintained by lainq Hosted on GitHub Pages — Theme by mattgraham

Termex

Explore the filesystem from your terminal
📖 Documentation · Report a Bug · Request Feature

About

Termex(Terminal Explorer) is a terminal-based file explorer created using typescript. The project was originally created for the Tech With Tim codejam.

Features

Terminal-based file navigation
View files with syntax highlighting
Discord RPC and many other small features

Read the documentation here

Installation

Manual installation

NPM

$ npm i termex -g

Building from source

Inorder to build the repository from your local system 💻, you will need to have the following programs installed:

Node JS
NPM
Git

Once you have installed all the required software, let’s get started by cloning the repository.

# Clone the repository into your local system
git clone https://github.com/pranavbaburaj/termex.git

# Get into the directory
cd termex

Build the project

# Install typescript to compile the source
npm i typescript -D

# Install node-gyp(Required by discord-rpc) and pkg(to package the application)
npm install node-gyp pkg

# Install all the other dependencies
npm install

# Compile the source into dist directory
tsc index.ts --esModuleInterop true --allowJs true --outDir ./dist


# Build the application into an executable
pkg -c package.json ./dist/index.js

Once you are done with the installation, add the executable into the PATH envrionment variable and start using termex.

Please mind reading the documentation before using termex. Learn more about documentation here

Documentation

Read the official documentation here. If you find any issues with the documentation, please let us know by creating an issue.