ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Shell Exec

by gbaptista ST3 Trending

Run shell commands like git, rvm, rspec, ls, etc. with Bash, Zsh and others inside your Sublime Text 3.

Details

Installs

  • Total 12K
  • Win 5K
  • OS X 4K
  • Linux 3K
Feb 25 Feb 24 Feb 23 Feb 22 Feb 21 Feb 20 Feb 19 Feb 18 Feb 17 Feb 16 Feb 15 Feb 14 Feb 13 Feb 12 Feb 11 Feb 10 Feb 9 Feb 8 Feb 7 Feb 6 Feb 5 Feb 4 Feb 3 Feb 2 Feb 1 Jan 31 Jan 30 Jan 29 Jan 28 Jan 27 Jan 26 Jan 25 Jan 24 Jan 23 Jan 22 Jan 21 Jan 20 Jan 19 Jan 18 Jan 17 Jan 16 Jan 15 Jan 14 Jan 13 Jan 12 Jan 11
Windows 0 9 7 7 2 2 1 2 4 1 6 3 6 3 4 3 1 3 5 9 7 1 2 3 9 6 5 2 2 1 7 10 7 3 2 2 5 5 4 6 9 2 4 0 8 3
OS X 0 6 7 1 7 2 2 4 1 0 3 5 4 1 4 3 6 1 3 5 3 3 3 7 4 4 2 7 1 1 1 2 3 2 3 3 5 4 2 6 6 1 3 1 3 4
Linux 1 4 7 3 8 3 2 2 1 3 5 1 4 9 3 0 1 4 4 5 4 0 1 6 8 1 3 3 0 1 5 6 4 7 7 4 4 2 1 2 4 2 1 0 3 6

Readme

Source
raw.​githubusercontent.​com

Shell Exec

Run shell commands like git, rvm, rspec, ls, etc. with Bash, Zsh and others inside your Sublime Text 3.

Demo: RSpec inside Sublime

Command Palette

Shell Exec: Open shell_exec_open

Default Shortcuts

  • Linux: ctrl + shift + c
  • Mac: shift + super + c
  • Windows: ctrl + shift + c

Settings

User/Preferences.sublime-settings:

// You can use this file to load RVM, ~/.bashrc, custom shell functions...
// "shell_exec_load_sh_file": "your-sh-file-to-load-before-commands.sh",

// Shell executable: "/bin/bash", "/bin/sh", "/usr/bin/zsh"...
"shell_exec_executable": "/bin/bash",

// Shell executable option: --login # Run as login load your ~/.bashrc or other user settings.
"shell_exec_executable_option": "--login", // ["-l"] ["--login"]

// The output of the command can be shown on the Panel or in a New File: "panel", "file" or "none".
"shell_exec_output": "file",

// Set the Output File Syntax. Default is Ruby, because Ruby looks nice. =)
"shell_exec_output_syntax": "Ruby",

// Enable or Disable the  word wrap at the Output File.
"shell_exec_output_word_wrap": true,

// Enable or Disable the Debug infos (for plugin developers).
"shell_exec_debug": false,

// Name of the Shell Exec command box.
"shell_exec_title": "Shell Exec",

// Defines where the command should be executed: false, "project_folder" or "file_folder".
// If "project_folder" is set, will execute: cd project_folder && your_commnad.
"shell_exec_context": "project_folder",

Custom Shortcuts

shell_exec_open: Open Shell Exec box to input some command.

shell_exec_run: Runs a predefined command.

User/Default (Linux).sublime-keymap:

{
  // (ctrl+shift+c+o) key binding
  "keys": ["ctrl+shift+c", "ctrl+shift+o"],

  // "shell_exec_open": Open Shell Exec box to input some command.
  // "shell_exec_run": Runs a predefined command.
  "command": "shell_exec_open",

  "args": {
    // Title of the Shell Exec box.
    "title": "Shell Exec",

    // Predefined command.
    "command": "git status",

    // Format the command with variables.
    "format": "git ${input}",

    // You can use this file to load RVM, ~/.bashrc, custom shell functions...
    // "load_sh_file": "your-sh-file-to-load-before-commands.sh",

    // Shell executable: "/bin/bash", "/bin/sh", "/usr/bin/zsh"...
    "executable": "/bin/bash",

    // Shell executable option: --login # Run as login load your ~/.bashrc or other user settings.
    "executable_option": "--login", // ["-l"] ["--login"]

    // The output of the command can be shown on the Panel or in a New File: "panel", "file".
    "output": "file",

    // Set the Output File Syntax. Default is Ruby, because Ruby looks nice. =)
    "output_syntax": "Ruby",

    // Enable or Disable the  word wrap at the Output File.
    "output_word_wrap": true,

    // Enable or Disable the Debug infos (for plugin developers).
    "debug": false,

    // Name of the Shell Exec command box.
    "title": "Shell Exec",

    // Defines where the command should be executed: false, "project_folder" or "file_folder".
    // If "project_folder" is set, will execute: cd project_folder && your_commnad.
    "context": "project_folder",
  }
}

Command Format Syntax

// (ctrl+shift+c+f) key binding
"keys": ["ctrl+shift+c", "ctrl+shift+f"],

// "shell_exec_open": Open Shell Exec box to input some command.
// "shell_exec_run": Runs a predefined command.
"command": "shell_exec_exec",

"args": {
    // Format the command with variables.
    "format": "rspec '${file}:${row}'"
}

Available variables: * ${input}: Input from Shell Exec box. * ${region}: Selected text. * ${row}: Selected row number or the cursor position at file. * ${file_name}: ShellExec.py * ${file}: /home/user/.config/sublime-text-3/Packages/shell-exec/ShellExec.py * ${packages}: /home/user/.config/sublime-text-3/Packages * ${file_base_name}: ShellExec * ${platform}: Linux * ${file_extension}: py * ${file_path}: /home/user/.config/sublime-text-3/Packages/shell-exec * ${folder}: /home/user/.config/sublime-text-3/Packages/shell-exec

Common Problems

RVM Command, ~/.bashrc, ~/.bash_profile, ~/.zshrc…

You can load RVM and profile files with login mode:

// Shell executable: "/bin/bash", "/bin/sh", "/usr/bin/zsh"...
"shell_exec_executable": "/bin/bash",

// Shell executable option: --login # Run as login load your ~/.bashrc or other user settings.
"shell_exec_executable_option": "--login", // ["-l"] ["--login"]

Or… You can load a custom sh file:

"shell_exec_load_sh_file": "my-config-loader-file.sh"

my-config-loader-file.sh: Loading ~/.bashrc simulating interactive shell:

PS1=true # Simulate Interactive Shell
source ~/.bashrc

my-config-loader-file.sh: Loading RVM command:

export PATH="$PATH:$HOME/.rvm/bin" # Add RVM to PATH for scripting
[[ -s "$HOME/.rvm/scripts/rvm" ]] && source "$HOME/.rvm/scripts/rvm"

Debugging

Just enable the debug to see panel outputs: User/Preferences.sublime-settings:

// Enable or Disable the Debug infos (for plugin developers).
"shell_exec_debug": true,

Some Cool Demos

Git

{
  "keys": ["ctrl+shift+g", "ctrl+shift+g"],
  "command": "shell_exec_open",
  "args": { "title": "Git Command:", "format": "git ${input}" }
},
{
  "keys": ["ctrl+shift+g", "ctrl+shift+c"],
  "command": "shell_exec_open",
  "args": {
    "title": "Git Checkout:",
    "format": "git checkout ${input}",
    "command": "'${file}'"
  }
},
{
  "keys": ["ctrl+shift+g", "ctrl+shift+s"],
  "command": "shell_exec_run",
  "args": { "command": "git status" }
},
{
  "keys": ["ctrl+shift+g", "ctrl+shift+d", "ctrl+shift+a"],
  "command": "shell_exec_run",
  "args": { "command": "git diff", "output_syntax": "Diff" }
},
{
  "keys": ["ctrl+shift+g", "ctrl+shift+d", "ctrl+shift+f"],
  "command": "shell_exec_run",
  "args": { "command": "git diff '${file}'", "output_syntax": "Diff" }
},
{
  "keys": ["ctrl+shift+g", "ctrl+shift+b"],
  "command": "shell_exec_run",
  "args": { "command": "git blame '${file}'", "output_syntax": "Git Blame" }
}

RSpec

{
  "keys": ["ctrl+shift+r", "ctrl+shift+r"],
  "command": "shell_exec_open",
  "args": {
    "title": "RSpec Command:", "format": "rspec ${input} --require spec_helper"
  }
},
{
  "keys": ["ctrl+shift+r", "ctrl+shift+o"],
  "command": "shell_exec_open",
  "args": {
    "title": "RSpec Command:",
    "command": "'${file}:${row}'",
    "format": "rspec ${input} --require spec_helper"
  }
},
{
  "keys": ["ctrl+shift+r", "ctrl+shift+a"],
  "command": "shell_exec_run",
  "args": { "command": "rspec spec --require spec_helper" }
},
{
  "keys": ["ctrl+shift+r", "ctrl+shift+f"],
  "command": "shell_exec_run",
  "args": { "command": "rspec '${file}' --require spec_helper" }
},
{
  "keys": ["ctrl+shift+r", "ctrl+shift+l"],
  "command": "shell_exec_run",
  "args": { "command": "rspec '${file}:${row}' --require spec_helper" }
},
{
  "keys": ["ctrl+shift+r", "ctrl+shift+s"],
  "command": "shell_exec_run",
  "args": { "command": "rspec '${region}' --require spec_helper" }
}

Unix

{
  "keys": ["ctrl+shift+u", "ctrl+shift+p"],
  "command": "shell_exec_open",
  "args": {
    "title": "Find Process",
    "format": "ps aux | grep ${input}"
  }
}