OpenInTerminal Documentation

repository·master·Indexed 27 days ago

https://github.com/ji4n1ng/openinterminal

macOS utilities that allow users to quickly open the current directory or selected files and folders in a terminal emulator or text editor directly from Finder. Includes OpenInTerminal (full version with GUI preferences and keyboard shortcuts), OpenInTerminal-Lite, and OpenInEditor-Lite CLI. Provides instructions for Homebrew installation, manual setup, Finder extension configuration for macOS 14 and 15+, and custom command configurations for Neovim and Kitty.

Tokens
6.5K
Snippets
25
Records
53
Agent score
91%

What's inside OpenInTerminal

  1. Compare OpenInTerminal and OpenInTerminal-Lite

    master

    Choose the version that best fits your needs:

    OpenInTerminal

    Best if you want a full-featured experience with a graphical settings interface and keyboard shortcut support.

    • Features: Supports opening directories/files in terminals or editors, opening custom applications, and multi-language support.
    • UI: Includes a graphical settings interface and keyboard shortcut support.

    OpenInTerminal-Lite (OpenInEditor-Lite)

    Best if you want a lightweight, fast, and stable way to open terminals or editors with minimal overhead.

    • Features: Supports terminals (iTerm, Hyper, Alacritty, kitty, Warp, WezTerm, Tabby, Ghostty, cmux) and editors (VS Code, Xcode, JetBrains, Neovim, etc.).
    • Limitations: Does not include a graphical settings interface or keyboard shortcut support.
    • Usage: Designed for a single-click workflow.
  2. Choose between OpenInTerminal and OpenInTerminal-Lite

    master

    Decide which version to use based on your feature requirements:

    • OpenInTerminal: Best if you want full features, including GUI preferences and keyboard shortcuts.
    • OpenInTerminal-Lite: A lightweight, one-click version designed for speed without the overhead of GUI settings. It does not support GUI preferences or keyboard shortcuts.
  3. Manually enable Finder Extension on macOS 15 using pluginkit

    master

    If the Finder Extension is not showing up in System Settings on macOS 15, you can manually enable it using the pluginkit command-line tool.

    1. Find the extension's UUID by running: pluginkit -mAD -p com.apple.FinderSync -vvv
    2. Locate the UUID in the output.
    3. Enable the extension using the command: pluginkit -e "use" -u "<UUID>"
  4. Install OpenInTerminal-Lite or OpenInEditor-Lite via Homebrew

    master

    You can install the Lite versions of these applications using Homebrew Cask. After installation, you can drag the application from your Applications folder to the Finder toolbar while holding the Cmd key for quick access.

    Note: On the first run, macOS will request permissions for Finder and Terminal (or iTerm). You must grant these permissions for the app to function.

    brew install --cask openinterminal-lite
    # or
    brew install --cask openineditor-lite
  5. Install OpenInTerminal via Homebrew

    master

    You can install the full version of OpenInTerminal using Homebrew Cask.

    ⚠️ Important: Signed builds are no longer provided. You must either trust the unsigned binaries or sign them yourself. Refer to the Configuration documentation for instructions on how to install and trust unsigned apps.

    brew install --cask openinterminal
  6. Install unsigned OpenInTerminal applications

    master

    If macOS refuses to open the application (e.g., showing errors like “OpenInTerminal” is damaged or cannot be opened because Apple cannot check for malicious software), follow these steps:

    1. Move the application (OpenInTerminal.app, OpenInTerminal-Lite.app, or OpenInEditor-Lite.app) to the /Applications folder.
    2. Remove the macOS quarantine attribute to prevent App Translocation (which prevents Finder extensions from registering) and to clear the 'damaged' error:
    xattr -dr com.apple.quarantine /Applications/OpenInTerminal.app
    1. Launch the application.

    Note for macOS 15 (Sequoia) and later: If blocked, go to System Settings -> Privacy & Security -> Security and click Open Anyway.

    xattr -dr com.apple.quarantine /Applications/OpenInTerminal.app
  7. Install unsigned OpenInTerminal apps on macOS

    master

    If macOS refuses to open the app (e.g., showing a "damaged" or "malicious software" warning), follow these steps:

    1. Move the app (OpenInTerminal.app, OpenInTerminal-Lite.app, or OpenInEditor-Lite.app) into /Applications.
    2. Remove the macOS quarantine flag to clear the "damaged" warning and prevent App Translocation (which prevents the Finder extension from registering).
    3. Launch the app.

    Alternatively, you can right-click the app in Finder and select Open. On macOS 15 (Sequoia) or later, you may also need to go to System Settings -> Privacy & Security and click Open Anyway after the first blocked attempt.

    xattr -dr com.apple.quarantine /Applications/OpenInTerminal.app
  8. Enable the OpenInTerminal Finder Extension

    master

    To add the OpenInTerminal icon to your Finder toolbar:

    1. Right-click on the Finder toolbar.
    2. Select Customize Toolbar....
    3. Drag the OpenInTerminal icon into the toolbar.

    macOS 14 and earlier

    Ensure the extension is enabled in System Preferences:

    1. Open the OpenInTerminal app.
    2. Navigate to System Preferences -> Extensions -> Finder Extensions.
    3. Check the box next to OpenInTerminalFinderExtension.

    macOS 15 (Sequoia) and later

    1. Go to System Settings -> General -> Login Items & Extensions -> OpenInTerminal Extensions and enable File Provider.
    2. If it still doesn't appear, you may need to manually enable it using pluginkit (see below).