Bring a real terminal to Sublime Text
The first cross platform terminal for Sublime Text.
This package is heavily inspired by TerminalView. Compare with TerminalView, this has
Package Control.
run Terminus: Open Default Shell in Tab
OdatNurd has made several videos on Terminus. See, for examples,
Terminus comes with several shell configurations. The settings file should be quite self explanatory.
You may find these key bindings useful. To edit, run Preferences: Terminus Key Bindings.
Check the details for the arguments of terminus_open below.
[
{
"keys": ["alt+`"], "command": "toggle_terminus_panel"
}
][
{
"keys": ["ctrl+alt+t"], "command": "terminus_open", "args": {
"cwd": "${file_path:${folder}}"
}
}
]or by passing a custom cmd, say ipython
[
{
"keys": ["ctrl+alt+t"], "command": "terminus_open", "args": {
"cmd": "ipython",
"cwd": "${file_path:${folder}}"
}
}
]carry_file_to_pane[
{
"keys": ["ctrl+alt+t"],
"command": "terminus_open",
"args": {
"post_window_hooks": [
["carry_file_to_pane", {"direction": "down"}]
]
}
}
]Following keybinding can be considered if one wants to use ctrl+w to close terminals.
{
"keys": ["ctrl+w"], "command": "terminus_close", "context": [{ "key": "terminus_view"}]
}Preferences: Terminus Command Palette. Check the details for the arguments of terminus_open below[
{
"caption": "Terminus: Open Default Shell at Current Location",
"command": "terminus_open",
"args" : {
"cwd": "${file_path:${folder}}"
}
}
]or by passing custom cmd, say ipython
[
{
"caption": "Terminus: Open iPython",
"command": "terminus_open",
"args" : {
"cmd": "ipython",
"cwd": "${file_path:${folder}}",
"title": "iPython"
}
}
]carry_file_to_pane[
{
"caption": "Terminus: Open Default Shell in Split Tab",
"command": "terminus_open",
"args": {
"post_window_hooks": [
["carry_file_to_pane", {"direction": "down"}]
]
}
}
]It is possible to use Terminus as a build system. The target terminus_exec is a drop in replacement of the default target exec. It takes exact same arguments as terminus_open except that their default values are set differently.
terminus_cancel_build is used to cancel the build when user runs cancel_build triggered by ctrl+c (macOS) or ctrl+break (Windows / Linux).
The following is an example of build system define in project settings that run a python script
{
"build_systems":
[
{
"name": "Hello World",
"target": "terminus_exec",
"cancel": "terminus_cancel_build",
"cmd": [
"python", "helloworld.py"
],
"working_dir": "$folder"
}
]
}The same Hello World example could be specified via a .sublime-build file.
{
"target": "terminus_exec",
"cancel": "terminus_cancel_build",
"cmd": [
"python", "helloworld.py"
],
"working_dir": "$folder"
}Instead of cmd, user could also specify shell_cmd. In macOS and linux, a bash shell will be invoked; and in Windows, cmd.exe will be invoked.
{
"target": "terminus_exec",
"cancel": "terminus_cancel_build",
"shell_cmd": "python helloworld.py",
// to directly invoke bash command
// "shell_cmd": "echo helloworld",
"working_dir": "$folder"
}Bash: add the following in .bash_profile or .bashrc
if [ "$TERM_PROGRAM" == "Terminus-Sublime" ]; then
bind '"\e[1;3C": forward-word'
bind '"\e[1;3D": backward-word'
fiZsh: add the following in .zshrc
if [ "$TERM_PROGRAM" = "Terminus-Sublime" ]; then
bindkey "\e[1;3C" forward-word
bindkey "\e[1;3D" backward-word
fiSome programs, such as julia, do not recognize the standard keycodes for alt+left and alt+right. You could
bind them to alt+b and alt+f respectively
[
{ "keys": ["alt+left"], "command": "terminus_keypress", "args": {"key": "b", "alt": true}, "context": [{"key": "terminus_view"}] },
{ "keys": ["alt+right"], "command": "terminus_keypress", "args": {"key": "f", "alt": true}, "context": [{"key": "terminus_view"}] }
]terminus_open with…The fields cmd and cwd understand Sublime Text build system variables.
the setting view.settings().get("terminus_view.tag") can be used to identify the terminal and
keybind can be binded with specific tagged terminal
{
"keys": ["ctrl+alt+w"], "command": "terminus_close", "context": [
{ "key": "terminus_view.tag", "operator": "equal", "operand": "YOUR_TAG" }
]
}window.run_command(
"terminus_send_string",
{
"string": "ls\n",
"tag": "<YOUR_TAG>", # ignore this or set it to None to send text to the first terminal found
"visible_only": False, # send to visible terminal only, default is `False`. Only relevent when `tag` is None
}
)If tag is not provided or is None, the text will be sent to the first terminal found in the current window.
It is known that Terminus sometimes consumes a lot of memory after extensive use. It is because Sublime Text keeps an infinite undo stack. There is virtually no fix unless upstream provides an API to work with the undo stack. Meanwhile, users could execute Terminus: Reset to release the memory.
This issue has been fixed in Sublime Text >= 4114 and Terminus v0.3.20.
It is known that the color of the scrollback history will be lost when a terminal is maximized or minimized from or to the panel. There is no fix for this issue.
If you are using DA UI and your terminal panel has weird background color,
try playing with the setting panel_background_color or panel_text_output_background_color in DA UI: Theme Settings.
{
"panel_background_color": "$background_color"
}Or, to keep the Find and Replace panels unchanged:
"panel_text_output_background_color": "$background_color"Due to a upstream bug (may winpty or cmd.exe?), there may be arbitrary empty lines inserted between prompts if the panel is too short. It seems that cmder and powershell are not affected by this bug.
This package won't be possible without pyte, pywinpty and ptyprocess.
No open issues yet, or sync has not completed.