Skip to content

Latest commit

 

History

History
59 lines (42 loc) · 2.01 KB

README.md

File metadata and controls

59 lines (42 loc) · 2.01 KB

ThroughTheTerminal

A simple yet customizable script to open files in the terminal.

This project allows you to 'natively' open files, either through File Explorer or Finder, inside the terminal using your preferred terminal-based text editor.

Table of Contents

  1. Features
  2. Configuration
  3. Building Instructions

Features

  • Open files in a new terminal window.
  • Open files in a new tab inside an existing terminal window.
  • Supports Windows and macOS.
Terminal Platform Support
Windows Terminal Windows
Terminal macOS
WezTerm Windows & macOS

Configuration

The configuration file located at ~/.throughtheterminal uses the toml file format:

Key Description Options
terminal Which terminal you want files to open in. "Terminal", "Windows Terminal"
editor Which editor you want files to open in. "vim", "nvim", "emacs", etc.
method Whether you want files to open in a tab or window. "tab", "window"

An example .throughtheterminal configuration file might look something like this:

terminal = "WezTerm"
editor = "nvim"
method = "tab"

Building Instructions

Windows

git clone https://github.com/ostromia/throughtheterminal.git
cd .\throughtheterminal\
cargo build --release

macOS

git clone https://github.com/ostromia/throughtheterminal.git
cd throughtheterminal/
cargo bundle --release