Terminus for Sublime Text

You can customize how you interact with Terminus by adding key bindings. To edit them, run Preferences: Terminus Key Bindings.

Common useful bindings include:

• Toggle terminal panel: Uses toggle_terminus_panel.
• Open terminal at current file directory: Uses terminus_open with the cwd argument set to ${file_path:${folder}}.
• Close terminal: Use terminus_close with a context check for terminus_view to allow using ctrl+w specifically for terminals.

// Toggle terminal panel
[
    { "keys": ["alt+`"], "command": "toggle_terminus_panel" }
]

// Open terminal at current file directory
[
    { 
        "keys": ["ctrl+alt+t"], 
        "command": "terminus_open", 
        "args": { "cwd": "${file_path:${folder}}" } 
    }
]

// Close terminal with ctrl+w (only when in a terminus view)
{
    "keys": ["ctrl+w"],
    "command": "terminus_close",
    "context": [{ "key": "terminus_view" }]
}

Terminus can be controlled via the Sublime Text Python API using window.run_command.

Open a terminal with terminus_open

Use this to programmatically launch shells with specific configurations, environments, or tags.

Send text with terminus_send_string

Send strings (including newlines) to a specific terminal using its tag.

Identify and target specific terminals

Use view.settings().get("terminus_view.tag") to retrieve the tag of a view. You can then use this tag in key bindings to target specific terminals.

# Open a terminal
window.run_command(
    "terminus_open", {
        "cmd": None,
        "shell_cmd": None,
        "cwd": None,
        "env": {},
        "title": "My Terminal",
        "tag": "MY_TAG",
        "auto_close": False
    }
)

# Send text to a specific tagged terminal
window.run_command(
    "terminus_send_string", 
    {
        "string": "ls\n",
        "tag": "MY_TAG"
    }
)

Terminus provides a wide range of Sublime Text commands to manage terminal views, shell execution, and terminal-specific interactions. These commands can be invoked via the Command Palette, Key Bindings, or the Context Menu.

Terminal Management

• terminus_open: Opens a new terminal view.
• terminus_activate: Activates a terminal view.
• terminus_close: Closes the current terminal view.
• terminus_close_all: Closes all open terminal views across all windows.
• terminus_maximize: Maximizes the terminal view.
• terminus_minimize: Minimizes the terminal view.
• terminus_toggle_panel: Toggles the Terminus panel.
• terminus_reset: Resets the terminal view.
• terminus_nuke: Forcefully destroys a terminal view.

Shell and Execution

• terminus_exec: Executes a command in a terminal.
• terminus_send_string: Sends a string of text to the terminal.
• terminus_cancel_build: Cancels the current build process.
• terminus_initialize_view: Initializes a view for terminal use.

Clipboard and Text Interaction

• terminus_copy: Copies text from the terminal.
• terminus_paste: Pastes text into the terminal.
• terminus_paste_from_history: Pastes text from the Terminus clipboard history.
• terminus_paste_text: Pastes specific text into the terminal.
• terminus_insert: Inserts text into the terminal.
• terminus_delete_word: Deletes the word at the cursor (Unix-style).
• terminus_trim_trailing_lines: Trims trailing lines in the view.

Rendering and UI

• terminus_render: Triggers a terminal render.
• terminus_show_cursor: Controls cursor visibility.
• terminus_cleanup: Performs cleanup operations.
• terminus_rename_title: Renames the terminal title.
• terminus_select_theme: Opens the theme selection interface.
• terminus_generate_theme: Generates a new theme.

Mouse and Context

• terminus_click: Handles mouse clicks within the terminal.
• terminus_open_context_url: Opens a URL found in the terminal context.
• terminus_open_image: Opens an image found in the terminal context.