{"id":25980560,"url":"https://github.com/lainq/termex","last_synced_at":"2025-03-05T07:36:57.002Z","repository":{"id":143918203,"uuid":"375036730","full_name":"lainq/termex","owner":"lainq","description":"Explore the filesystem from your terminal","archived":false,"fork":false,"pushed_at":"2021-10-24T10:34:13.000Z","size":7109,"stargazers_count":23,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2023-12-07T15:03:15.143Z","etag":null,"topics":["explorer","file-explorer","hacktoberfest","terminal","terminal-explorer","typescript"],"latest_commit_sha":null,"homepage":"https://pranavbaburaj.github.io/termex/","language":"TypeScript","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/lainq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null},"funding":{"github":null,"patreon":"pranavbaburaj"}},"created_at":"2021-06-08T14:21:39.000Z","updated_at":"2023-09-13T06:33:25.000Z","dependencies_parsed_at":"2023-07-28T17:49:35.056Z","dependency_job_id":null,"html_url":"https://github.com/lainq/termex","commit_stats":null,"previous_names":["lainq/termex","pranavbaburaj/termex"],"tags_count":5,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lainq%2Ftermex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lainq%2Ftermex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lainq%2Ftermex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lainq%2Ftermex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lainq","download_url":"https://codeload.github.com/lainq/termex/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241989814,"owners_count":20053801,"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":["explorer","file-explorer","hacktoberfest","terminal","terminal-explorer","typescript"],"created_at":"2025-03-05T07:36:56.242Z","updated_at":"2025-03-05T07:36:56.996Z","avatar_url":"https://github.com/lainq.png","language":"TypeScript","funding_links":["https://patreon.com/pranavbaburaj"],"categories":[],"sub_categories":[],"readme":"\u003cbr /\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://i.imgur.com/uP8MCw0.gif\" height=\"120\"\u003e\n  \u003ch3 align=\"center\"\u003e\u003ci\u003e\u003cstrong\u003eTermex\u003c/strong\u003e\u003c/i\u003e\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    Explore the filesystem from your terminal\n  \u003cbr /\u003e\n    \u003ca href=\"https://github.com/pranavbaburaj/termex/blob/main/docs/README.md\"\u003e📖 Documentation\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/pranavbaburaj/termex/issues\"\u003eReport a Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/pranavbaburaj/termex/pulls\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n  \u003cbr\u003e\n  \u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://badges.frapsoft.com/os/v1/open-source.svg?v=103\"\u003e\n    \u003cimg src=\"https://tokei.rs/b1/github/pranavbaburaj/termex\"\u003e\n  \u003c/p\u003e\n  \u003cbr /\u003e\n\n\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://user-images.githubusercontent.com/70764593/124089457-89068e80-da71-11eb-9ddb-e51cf84a0369.gif\" height=\"300\"\u003e\n \u003c/div\u003e\n\n# About\n\nTermex(**Ter**minal **Ex**plorer) is a terminal-based file explorer created using typescript.\n\n# Features\n\n- [x] Terminal-based file navigation\n- [x] View files with syntax highlighting\n- [x] Discord RPC\n      and many other small features\n\n  #### WIP\n\n  - [ ] Github Gists\n\nRead the documentation [here](https://github.com/pranavbaburaj/termex/tree/main/docs)\n\n# Installation\n\n## Manual installation\n\u003c!--\n\n- **NPM**\n\n```ps1\n$ npm i termex -g\n```\n\n\u003c!-- - **Windows**\n\nWindows users can download the zip file from the [releases](https://github.com/pranavbaburaj/termex/releases/latest/). Unzip the downloaded file and you can find the termex executable in the directory. An alternate wa is to build from source. You can learn more about it [here](https://github.com/pranavbaburaj/termex#building-from-source)\n\n- **Other platforms**\n  Non-Windows users require to build the application from source. Read more about it [here](https://github.com/pranavbaburaj/termex#building-from-source) --\u003e\n\n## Building from source\n\nInorder to build the repository from your local system 💻, you will need to have the following programs installed:\n\n- [Node JS](https://nodejs.org/)\n- [NPM](https://npmjs.com/)\n- [Git](https://git-scm.com/)\n\nOnce you have installed all the required software, let's get started by cloning the repository.\n\n```ps1\n# Clone the repository into your local system\ngit clone https://github.com/pranavbaburaj/termex.git\n\n# Get into the directory\ncd termex\n```\n\nBuild the project\n\n```ps1\n# Install typescript to compile the source\nnpm i typescript -D\n\n# Install node-gyp(Required by discord-rpc) and pkg(to package the application)\nnpm install node-gyp pkg\n\n# Install all the other dependencies\nnpm install\n\n# Compile the source into dist directory\ntsc index.ts --esModuleInterop true --allowJs true --outDir ./dist\n\n\n# Build the application into an executable\npkg -c package.json ./dist/index.js\n```\n\n\u003chr\u003e\n\nOnce you are done with the installation, add the executable into the `PATH` envrionment variable and start using termex.\n\nPlease mind reading the documentation before using termex. Learn more about documentation [here](https://github.com/pranavbaburaj/termex#Documentation)\n\n# Documentation\n\nRead 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).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flainq%2Ftermex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flainq%2Ftermex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flainq%2Ftermex/lists"}