akinsho/toggleterm.nvim
Toggleterm.nvim
toggleterm.nvim is a Lua-based terminal manager and session orchestrator for Neovim. It provides a system for opening, hiding, and organizing multiple persistent terminal windows, allowing shell sessions to be integrated directly within the text editor.
The plugin distinguishes itself by offering a floating terminal interface and the ability to define custom terminal classes. These classes allow for specialized instances with dedicated commands and environment variables, while named terminal selection enables users to focus specific sessions using descriptive labels rather than numeric identifiers.
The project covers workspace layout configuration, allowing terminals to be oriented as floating windows, vertical splits, or tabs. It includes capabilities for session control, such as transferring text from editor buffers directly into active terminals, executing targeted shell commands, and performing bulk operations to manage multiple active sessions.
Features
- Neovim Plugins - Provides a comprehensive terminal management system as a Neovim plugin.
- Terminal Session Managers - Provides a system for opening, hiding, and organizing multiple persistent terminal windows within the editor.
- Terminal Managers - Acts as a specialized manager for opening, hiding, and organizing multiple persistent terminal windows within Neovim.
- Shell Command Execution - Allows running specific scripts or commands in a designated terminal while managing working directories.
- Terminal Buffer Injections - Sends selected lines of code or text from an editor buffer directly into a running terminal for immediate execution.
- Terminal Buffer Integrations - Wraps native Neovim terminal buffers to manage lifecycle events and window placement logic.
- Custom Terminal Classes - Enables defining specialized terminal instances with dedicated commands and environment variables for tool-specific workflows.
- Floating Terminal Toggles - Displays terminal sessions as floating windows that can be toggled to maintain a focused coding environment.
- Terminal Orchestrators - Orchestrates the naming, selection, and text-transfer capabilities across multiple shell instances.
- Shell Session Persistence - Runs shell commands and scripts while maintaining a persistent session for long-running tasks.
- Session Management Identifiers - Associates unique numeric IDs with descriptive names to target and focus specific terminal sessions.
- Editor-to-Terminal Pipes - Transfers text from the current editor buffer to the terminal input stream using native APIs.
- Editor Workspace Managers - Arranges floating windows, vertical splits, and tabs to balance code editing with real-time command line output.
- Bulk Operations - Provides the ability to open or close all active terminals simultaneously.
- Named Selection - Allows assigning descriptive names to instances to focus specific terminals via a selection interface.
- Session Labeling - Allows assigning descriptive names to terminal identifiers for identification within the window bar or selection menu.
- Command Dispatching - Maps user-defined labels to specific shell commands for targeted session execution within the editor.
- Terminal Session Persisters - Enables opening, hiding, and restoring terminal windows while maintaining the current session state.
- Shell Integration - Supports connecting the interface to system shells by configuring execution flags and encoding settings.
- Tooling Integrations - Connects specialized CLI tools to the editor environment with dedicated configurations for project tasks.
- Terminal Workspace Layouts - Organizes the workspace by setting display orientations as floating windows, vertical splits, or tabs.
- Floating Content Windows - Calculates screen real estate to spawn terminal buffers as floating windows, vertical splits, or tabs.
- Targeted Execution - Supports executing shell commands in a specific target terminal while defining the working directory and window size.
- Terminal Integration - Manages multiple terminal windows within the editor.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
