# Sublime Terminal

Shortcuts and menu entries for opening a terminal at the current file, or any directory in [Sublime Text](http://sublimetext.com/).

## Installation

Download [Package Control](https://packagecontrol.io/) and use the *Package Control: Install Package* command from the command palette. Using Package Control ensures Terminal will stay up to date automatically.

## Usage

- **Open Terminal at File**
  Opens a terminal in the folder containing the currently opened file.  
- **Open Terminal at Project Folder**
  Opens a terminal in the project folder containing the currently opened file.  

Terminals can be opened via the command palette, the editor context menu and the sidebar context menus. Additionally, you can set up key bindings.

### Key bindings

To create keyboard shortcuts, open the *Preferences > Package Settings > Terminal > Key Bindings* menu entry. Our suggested key bindings are on the left, you can copy these over to your personal bindings on the right and tweak them to your liking. Example:

```json
[
  { "keys": ["super+shift+t"], "command": "open_terminal" },
  { "keys": ["super+shift+alt+t"], "command": "open_terminal_project_folder" }
]
```

Note that in version 2 of this package, we stopped enabling these bindings by default. They conflicted with built-in bindings of Sublime Text, and users might have different preferences.

## Package Settings

The settings can be viewed and edited by accessing the *Preferences > Package Settings > Terminal > Settings* menu entry. 

 - **terminal**
     - The terminal to execute, will default to the OS default if blank.
     - Default: `""`
 - **parameters**
     - The parameters to pass to the terminal. These parameters will be used if no [custom parameters](#custom-parameters) are passed.
     - Default: `[]`
 - **env**
     - The environment variables changeset. Default environment variables used when invoking the terminal are inherited from Sublime Text.
     - The changeset may be used to overwrite/unset environment variables. Use `null` to indicate that the environment variable should be unset.
     - Default: `{}`

## Custom Parameters

By passing parameters argument to the `open_terminal` or `open_terminal_project_folder` commands, it is possible to construct custom terminal environments. You can do so by creating custom [key bindings](https://www.sublimetext.com/docs/key_bindings.html) that call these commands with the arguments you want, as we'll document here, or by adding custom [command palette](https://docs.sublimetext.io/reference/command_palette.html) or [menu entries](https://docs.sublimetext.io/reference/menus.html). 

The following is an example, of passing the parameters `-T 'Custom Window Title'`` to an XFCE terminal.

```json
{
 "keys": ["ctrl+alt+t"],
 "command": "open_terminal",
 "args": {
   "parameters": ["-T", "Custom Window Title"]
 }
}
```

A parameter may also contain the *%CWD%* placeholder, which will be substituted with the current working directory the terminal was opened to.

```json
{
 "keys": ["ctrl+alt+t"],
 "command": "open_terminal",
 "args": {
   "parameters": ["-T", "Working in directory %CWD%"]
 }
}
```

## Example configurations

Here are some example configurations calling different terminals. Note that paths to executables might differ on your machine.

### Cmder on Windows

```json
{
  "terminal": "C:\\Program Files\\cmder_mini\\cmder.exe",
  "parameters": ["/START", "%CWD%"]
}
```

### xterm on GNU/Linux

```json
{
  "terminal": "xterm"
}
```

### gnome-terminal for CJK users on GNU/Linux

We unset LD_PRELOAD, as it may cause problems for Sublime Text with imfix.

```json
{
  "terminal": "gnome-terminal",
  "env": {"LD_PRELOAD": null}
}
```
### iTerm on MacOS.

```json
{
  "terminal": "iTerm.sh"
}
```

### iTerm on MacOS. with tabs

```json
{
  "terminal": "iTerm.sh",
  "parameters": ["--open-in-tab"]
}
```

### iTerm2 v3 on MacOS.

```json
{
  "terminal": "iTerm2-v3.sh"
}
```

### Hyper on MacOS.

```json
{
  "terminal": "hyper.sh"
}
```

### Kitty on OS X

```json
{
  "terminal": "/opt/homebrew/bin/kitty",
  "parameters": ["-d", "%CWD%"]
}
```

### [Windows Terminal](https://github.com/microsoft/terminal)

```json
{
  "terminal": "C:/Users/yourusername/AppData/Local/Microsoft/WindowsApps/wt.exe",
  "parameters": ["-d", "."]
}
```