Sublime Merge

https://www.sublimemerge.com/
Admin
Sublime Merge is a Git client for macOS, Windows, and Linux that provides an intuitive interface for...
Tokens:15,525
Snippets:294
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Example .sublime-keymap file structure

Source: https://www.sublimemerge.com/docs/key_bindings

A complete example showing the top-level array structure and various binding configurations.

```json
[
    {
        "keys": ["super+shift+b"],
        "command": "show_command_palette",
        "args": {"command": "create_branch"}
    },
    {
        "keys": ["super+f"], "command": "toggle_search",
        "context": [{"operator": "not_equal", "key": "merge_mode"}]
    },
    { "keys": ["super+left"], "command": "navigate_back" },
    { "keys": ["super+right"], "command": "navigate_forward" },
]
```

--------------------------------

### Example .sublime-commands file structure

Source: https://www.sublimemerge.com/docs/command_palette

Demonstrates the top-level array structure and multiple command definitions.

```json
[
    {
        "caption": "View: Toggle Side Bar",
        "command": "toggle_side_bar"
    },
    {
        "caption": "Checkout Branch…",
        "command": "checkout_branch",
    },
    {
        "caption": "Checkout Remote Branch…",
        "command": "checkout_branch",
        "args": { "local_refs": false, "remote_refs": true }
    },
]
```

--------------------------------

### Define a .sublime-menu file structure

Source: https://www.sublimemerge.com/docs/menus

Example of a standard menu definition file using nested children and platform-specific commands.

```json
[
    {
        "caption": "File",
        "mnemonic": "F",
        "id": "file",
        "children":
        [
            { "command": "new_window", "caption": "New Window" },
            { "command": "close_window", "caption": "Close Window" },
            { "caption": "-", "id": "exit" },
            { "command": "exit", "caption": "Exit", "mnemonic": "x", "platform": "Windows" },
            { "command": "exit", "caption": "Quit", "mnemonic": "Q", "platform": "Linux" },
        ]
    }
]
```

--------------------------------

### User-defined command entry

Source: https://www.sublimemerge.com/docs/command_palette

Example of a custom command added to the Packages/User/Default.sublime-commands file.

```json
[
    {
        "caption": "Cleanup Repo",
        "command": "git",
        "args": {"argv": ["gc"]}
    }
]
```

--------------------------------

### Define a .sublime-theme file structure

Source: https://www.sublimemerge.com/docs/themes

Example demonstrating variable definition and rule-based styling for UI elements like buttons and labels.

```json
{
                "variables":
                {
                    "light_gray": "rgb(240, 240, 240)"
                },
                "rules":
                [
                // Set up the textures for a button
                {
                    "class": "button_control",
                    "layer0.tint": "#000",
                    "layer0.opacity": 1.0,
                    "layer1.texture": "Theme - Example/textures/button_background.png",
                    "layer1.inner_margin": 4,
                    "layer1.opacity": 1.0,
                    "layer2.texture": "Theme - Example/textures/button_highlight.png",
                    "layer2.inner_margin": 4,
                    "layer2.opacity": 0.0,
                    "content_margin": [4, 8, 4, 8]
                },
                // Show the highlight texture when the button is hovered
                {
                    "class": "button_control",
                    "attributes": ["hover"],
                    "layer2.opacity": 1.0
                },
                // Basic text label style
                {
                    "class": "label_control",
                    "fg": "var(light_gray)",
                    "font.bold": true
                },
                // Brighten labels contained in a button on hover
                {
                    "class": "label_control",
                    "parents": [{"class": "button_control", "attributes": ["hover"]}],
                    "fg": "white"
                }
                ]
            }
```

--------------------------------

### Define key binding for Escape

Source: https://www.sublimemerge.com/docs/key_bindings

A simple binding example for the Escape key.

```json
{
    "keys": ["escape"],
    "command": "noop"
}
```

--------------------------------

### Define key binding with modifier

Source: https://www.sublimemerge.com/docs/key_bindings

A binding example using the Ctrl modifier with the A key.

```json
{
    "keys": ["ctrl+a"],
    "command": "noop"
}
```

--------------------------------

### Configure zypper Repository

Source: https://www.sublimemerge.com/docs/linux_repositories

Commands to import the GPG key and add the stable or dev repository for openSUSE.

```bash
sudo rpm -v --import https://download.sublimetext.com/sublimehq-rpm-pub.gpg
```

```bash
sudo zypper addrepo -g -f https://download.sublimetext.com/rpm/stable/x86_64/sublime-text.repo
```

```bash
sudo zypper addrepo -g -f https://download.sublimetext.com/rpm/dev/x86_64/sublime-text.repo
```

```bash
sudo zypper install sublime-merge
```

--------------------------------

### Configure apt Repository

Source: https://www.sublimemerge.com/docs/linux_repositories

Commands to set up the GPG key, enable https transport, and add the stable or dev repository for Debian-based systems.

```bash
wget -qO - https://download.sublimetext.com/sublimehq-pub.gpg | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/sublimehq-archive.gpg > /dev/null
```

```bash
sudo apt-get install apt-transport-https
```

```bash
echo "deb https://download.sublimetext.com/ apt/stable/" | sudo tee /etc/apt/sources.list.d/sublime-text.list
```

```bash
echo "deb https://download.sublimetext.com/ apt/dev/" | sudo tee /etc/apt/sources.list.d/sublime-text.list
```

```bash
sudo apt-get update
sudo apt-get install sublime-merge
```

--------------------------------

### Modify colors with color-mod function

Source: https://www.sublimemerge.com/docs/minihtml

Examples of using the color-mod function to adjust alpha transparency or blend colors with variables.

```css
.error {
    background-color: color(var(--background) alpha(0.25));
}
```

```css
.error {
    background-color: color(var(--background) blend(red 50%));
}
```

--------------------------------

### Configure dnf Repository

Source: https://www.sublimemerge.com/docs/linux_repositories

Commands to import the GPG key and add the stable or dev repository for Fedora, including specific commands for dnf5.

```bash
sudo rpm -v --import https://download.sublimetext.com/sublimehq-rpm-pub.gpg
```

```bash
sudo dnf config-manager --add-repo https://download.sublimetext.com/rpm/stable/x86_64/sublime-text.repo
```

```bash
sudo dnf config-manager addrepo --from-repofile=https://download.sublimetext.com/rpm/stable/x86_64/sublime-text.repo
```

```bash
sudo dnf config-manager --add-repo https://download.sublimetext.com/rpm/dev/x86_64/sublime-text.repo
```

```bash
sudo dnf config-manager addrepo --from-repofile=https://download.sublimetext.com/rpm/dev/x86_64/sublime-text.repo
```

```bash
sudo dnf install sublime-merge
```

--------------------------------

### Configure pacman Repository

Source: https://www.sublimemerge.com/docs/linux_repositories

Commands to import the GPG key and add the stable or dev repository for Arch Linux, supporting both x86_64 and aarch64 architectures.

```bash
curl -O https://download.sublimetext.com/sublimehq-pub.gpg && sudo pacman-key --add sublimehq-pub.gpg && sudo pacman-key --lsign-key 8A8F901A && rm sublimehq-pub.gpg
```

```bash
echo -e "\n[sublime-text]\nServer = https://download.sublimetext.com/arch/stable/x86_64" | sudo tee -a /etc/pacman.conf
```

```bash
echo -e "\n[sublime-text]\nServer = https://download.sublimetext.com/arch/dev/x86_64" | sudo tee -a /etc/pacman.conf
```

```bash
echo -e "\n[sublime-text]\nServer = https://download.sublimetext.com/arch/stable/aarch64" | sudo tee -a /etc/pacman.conf
```

```bash
echo -e "\n[sublime-text]\nServer = https://download.sublimetext.com/arch/dev/aarch64" | sudo tee -a /etc/pacman.conf
```

```bash
sudo pacman -Syu sublime-merge
```

--------------------------------

### Display smerge help

Source: https://www.sublimemerge.com/docs/command_line

Displays the command line usage and available options for smerge.

```text
Usage: smerge path               Open the given repository
             or: smerge search query       Search for commits in the current repository
             or: smerge blame file [line]  Blame the given file in the current repository
             or: smerge log file           Show the file history in the current repository
             or: smerge mergetool          Opens the merge tool for the given files
                   [--no-wait] [base] left right [-o merged]

            -n or --new-window:      Open a new window
            -b or --background:      Don't activate the application
            -h or --help:            Show help (this message) and exit
            -v or --version:         Show version and exit
```

--------------------------------

### Configure yum Repository

Source: https://www.sublimemerge.com/docs/linux_repositories

Commands to import the GPG key and add the stable or dev repository for CentOS systems.

```bash
sudo rpm -v --import https://download.sublimetext.com/sublimehq-rpm-pub.gpg
```

```bash
sudo yum-config-manager --add-repo https://download.sublimetext.com/rpm/stable/x86_64/sublime-text.repo
```

```bash
sudo yum-config-manager --add-repo https://download.sublimetext.com/rpm/dev/x86_64/sublime-text.repo
```

```bash
sudo yum install sublime-merge
```

--------------------------------

### Define a basic custom Git command

Source: https://www.sublimemerge.com/docs/custom_commands

Use this structure in your command files to execute a static Git command with predefined arguments.

```json
{
    "caption": "Interactive rebase onto main",
    "command": "git",
    "args": {
        "argv": [
            "rebase",
            "-i",
            "main"
        ]
    }
}
```

--------------------------------

### Define command with arguments

Source: https://www.sublimemerge.com/docs/key_bindings

Passes specific arguments to a command using the args key.

```json
{
    "keys": ["super+shift+b"],
    "command": "show_command_palette",
    "args": {"command": "create_branch"}
}
```

--------------------------------

### Wrap commands for context menus

Source: https://www.sublimemerge.com/docs/custom_commands

When using selectors in context menus, wrap the command in show_command_palette to ensure user input is collected correctly.

```json
{
    "caption": "Interactive rebase…",
    "command": "show_command_palette",
    "args": {
        "command": "git",
        "args": {
            "argv": [
                "rebase",
                "-i",
                "$select_branch"
            ]
        }
    }
}
```

--------------------------------

### Create custom remote context menu

Source: https://www.sublimemerge.com/docs/menus

Defines a custom menu entry for pruning stale refs by creating a Remote.sublime-menu file in the User directory.

```json
[
    {
        "caption": "Prune",
        "command": "git",
        "args": {"argv": ["remote", "prune", "$remote"]}
    }
]
```

--------------------------------

### Define command execution

Source: https://www.sublimemerge.com/docs/key_bindings

Specifies the command to execute when the defined keys are pressed.

```json
{
    "keys": ["super+left"],
    "command": "navigate_back"
}
```

--------------------------------

### Basic command entry

Source: https://www.sublimemerge.com/docs/command_palette

A minimal command palette entry requiring only a caption and a command name.

```json
{
    "caption": "View Tree",
    "command": "view_tree"
}
```

--------------------------------

### Command entry with arguments

Source: https://www.sublimemerge.com/docs/command_palette

Defines a command that passes specific arguments to the underlying execution logic.

```json
{
    "caption": "Push...",
    "command": "push",
    "args": {"prompt": true}
}
```

--------------------------------

### Create Linux symlink for smerge

Source: https://www.sublimemerge.com/docs/command_line

Creates a symbolic link to the sublime_merge binary in the user's bin directory on Linux.

```bash
ln -s /opt/sublime_merge/sublime_merge ~/bin/smerge
```

--------------------------------

### Use selectors for dynamic command arguments

Source: https://www.sublimemerge.com/docs/custom_commands

Replace hardcoded values with selectors like $select_branch to prompt the user for input when the command is executed.

```json
{
    "caption": "Interactive rebase…",
    "command": "git",
    "args": {
        "argv": [
            "rebase",
            "-i",
            "$select_branch"
        ]
    }
}
```

--------------------------------

### Create Mac symlink for smerge

Source: https://www.sublimemerge.com/docs/command_line

Creates a symbolic link to the smerge binary in the user's bin directory on macOS.

```bash
ln -s "/Applications/Sublime Merge.app/Contents/SharedSupport/bin/smerge" ~/bin/smerge
```

--------------------------------

### Configure Git merge tool

Source: https://www.sublimemerge.com/docs/command_line

Configures Git to use smerge as the default merge tool.

```bash
git config mergetool.smerge.cmd 'smerge mergetool "$BASE" "$LOCAL" "$REMOTE" -o "$MERGED"'
```

```bash
git config mergetool.smerge.trustExitCode true
```

```bash
git config merge.tool smerge
```

--------------------------------

### Define Custom Key Binding

Source: https://www.sublimemerge.com/docs/key_bindings

Create a new key binding by adding an object to the array in the Default.sublime-keymap file.

```json
[
    {
        "keys": ["super+shift+g"],
        "command": "git",
        "args": {"argv": ["gc"]}
    }
]
```

--------------------------------

### Define and use theme variables

Source: https://www.sublimemerge.com/docs/themes

Variables are defined in a top-level JSON object and referenced using the var() syntax. The variable must represent the entire property value.

```json
{
                "variables":
                {
                    "light_gray": "rgb(240, 240, 240)"
                },
                "rules":
                [
                {
                    "class": "label_control",
                    "fg": "var(light_gray)"
                }
                ]
            }
```

--------------------------------

### Customize theme font sizes

Source: https://www.sublimemerge.com/docs/themes

This JSON configuration increases the font size for the location bar heading and label elements. Place this in a file named after the theme within the Packages/User/ directory.

```json
[
            {
                "class": "location_bar_heading",
                "font.size": 15,
            },
            {
                "class": "location_bar_label",
                "font.size": 14
            }
        ]
```

--------------------------------

### Append entry to repository submenu

Source: https://www.sublimemerge.com/docs/menus

Adds a 'Cleanup Repo' command to the existing repository submenu by referencing its ID.

```json
[
    {
        "id": "repository",
        "children":
        [
            {
                "caption": "Cleanup Repo",
                "command": "git",
                "args": {"argv": ["gc"]}
            }
        ]
    }
]
```

--------------------------------

### Specify colors using CSS syntax

Source: https://www.sublimemerge.com/docs/themes

Colors can be defined using various CSS notations supported by minihtml.

```css
#fff
```

```css
rgb(255, 255, 255)
```

```css
hsla(0, 100%, 100%, 0.5)
```

```css
var(--redish)
```

```css
color(var(--redish) a(0.5))
```

--------------------------------

### Invoke Git merge tool

Source: https://www.sublimemerge.com/docs/command_line

Command to trigger the configured merge tool for resolving conflicts.

```bash
git mergetool
```
Tokens:
Raw