https://github.com/lainq/termex
Explore the filesystem from your terminal
https://github.com/lainq/termex
explorer file-explorer hacktoberfest terminal terminal-explorer typescript
Last synced: 7 months ago
JSON representation
Explore the filesystem from your terminal
- Host: GitHub
- URL: https://github.com/lainq/termex
- Owner: lainq
- License: mit
- Created: 2021-06-08T14:21:39.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-10-24T10:34:13.000Z (almost 4 years ago)
- Last Synced: 2023-12-07T15:03:15.143Z (almost 2 years ago)
- Topics: explorer, file-explorer, hacktoberfest, terminal, terminal-explorer, typescript
- Language: TypeScript
- Homepage: https://pranavbaburaj.github.io/termex/
- Size: 6.78 MB
- Stars: 23
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Termex
Explore the filesystem from your terminal
📖 Documentation
·
Report a Bug
·
Request Feature
# About
Termex(**Ter**minal **Ex**plorer) is a terminal-based file explorer created using typescript.
# Features
- [x] Terminal-based file navigation
- [x] View files with syntax highlighting
- [x] Discord RPC
and many other small features
#### WIP
- [ ] Github Gists
Read the documentation [here](https://github.com/pranavbaburaj/termex/tree/main/docs)
# Installation
## Manual installation
## Building from source
Inorder to build the repository from your local system 💻, you will need to have the following programs installed:
- [Node JS](https://nodejs.org/)
- [NPM](https://npmjs.com/)
- [Git](https://git-scm.com/)
Once you have installed all the required software, let's get started by cloning the repository.
```ps1
# Clone the repository into your local system
git clone https://github.com/pranavbaburaj/termex.git
# Get into the directory
cd termex
```
Build the project
```ps1
# 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](https://github.com/pranavbaburaj/termex#Documentation)
# Documentation
Read the official documentation [here](https://github.com/pranavbaburaj/termex/blob/main/docs/README.md). If you find any issues with the documentation, please let us know by creating an [issue](https://github.com/pranavbaburaj/termex/issues/new).