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

Sesame

by gerardroche ST3

Add, open, remove, switch, and manage projects and folders, using the command palette and key bindings.

Details

Installs

  • Total 580
  • Win 248
  • Mac 213
  • Linux 119
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 Jan 10 Jan 9 Jan 8 Jan 7 Jan 6 Jan 5 Jan 4 Jan 3 Jan 2 Jan 1 Dec 31 Dec 30 Dec 29 Dec 28 Dec 27 Dec 26 Dec 25 Dec 24 Dec 23 Dec 22
Windows 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Mac 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

Sesame

Latest Version GitHub stars Downloads

About Sesame

Open sesame” is a magical phrase in the story of “Ali Baba and the Forty Thieves” in Antoine Galland's version of One Thousand and One Nights. It opens the mouth of a cave in which forty thieves have hidden a treasure.

Sesame is a Sublime Text that provides quick opening, adding, removing, and switching of your projects.

Installation

Package Control installation

The preferred method of installation is Package Control.

Manual installation

Close Sublime Text, then download or clone this repository to a directory named Sesame in the Sublime Text Packages directory for your platform:

Linux

git clone https://github.com/gerardroche/sublime-sesame.git ~/.config/sublime-text-3/Packages/Sesame

OSX

git clone https://github.com/gerardroche/sublime-sesame.git ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/Sesame

Windows

git clone https://github.com/gerardroche/sublime-sesame.git %APPDATA%\Sublime/ Text/ 3/Packages/Sesame

Quick start

Set the location of your projects.

Menu > Preferences > Settings

{
    "sesame.path": "~/projects"
}

Press Ctrl+Alt+o (Linux, Windows) or Super+Alt+o (OSX), to open a project.

Key bindings

Configure your preferred key bindings.

By default only the Open Sesame command enabled.

Menu > Preferences > Key Bindings

[
    { "keys": ["ctrl+alt+o"], "command": "sesame_open" },
    { "keys": ["ctrl+alt+a"], "command": "sesame_add" },
    { "keys": ["ctrl+alt+r"], "command": "sesame_remove" },
    { "keys": ["ctrl+alt+s"], "command": "sesame_switch" },
]

Commands

Command Palette Command Description
Sesame: Open sesame_open Open a project in a new window
Sesame: Add sesame_add Add a project to the current window
Sesame: Remove sesame_remove Remove a project from the current window
Sesame: Switch sesame_switch Switch to a project in the current window

Configuration

Key Description Type Default
sesame.path Location of projects. string or list[str, dict] The value found in the environment variable PROJECTS_PATH (if it exists).
sesame.depth Number of levels deep to look for projects within path. int 1 or 2 2
sesame.keymaps Enable default key bindings. boolean true
sesame.vcs Include/exclude version controlled projects e.g. Git, Mercurial, Subversion: true means include only version controlled projects, false means exclude them, and null (default), means version controlled and non-version controlled projects are included. boolean or null null

sesame.path

Menu > Preferences > Settings

{
    "sesame.path": "~/projects"
}

Multiple paths can be set using a PATH separator (':' for POSIX or ';' for Windows):

{
    "sesame.path": "~/projects:~/work:~/src"
}

Or as a list:

{
    "sesame.path": ["~/projects", "~/work", "~/src"]
}

A PROJECTS_PATH environment variable can be used to set a default projects path (instead of using the setting sesame.path described above) e.g. on Linux edit ~/.profile (may require a system restart):

export PROJECTS_PATH=~/projects

sesame.depth

Projects are located using the pattern */* e.g. vendor/name.

If you prefer to organise your projects on a single directory level, set the depth to 1:

The default depth is 2

Menu > Preferences > Settings

{
    "sesame.depth": 2
}

Multiple project paths

If you have multiple projects paths configured, you can configure the depth and other settings on a path-by-path basis in the following way. A path with no specific setting will fallback to the root setting.

Menu > Preferences > Settings

{
    "sesame.path": [
        {"path": "~/projects/a", "depth": 1}
        {"path": "~/projects/b", "vcs": true}
    ],
    "sesame.depth": 2
}

Example setups

Adding sesame commands Key Bindings.

Menu > Preferences > Key Bindings

[
   { "keys": ["ctrl+alt+v"], "command": "sesame_open", "args": { "path": "~/vendor" } }
]

Adding sesame commands to the Command Palette.

Create User/Default.sublime-commands

[
   { "caption": "Sesame: Open Vendor", "command": "sesame_open", "args": { "path": "~/vendor" } },
]

Changelog

See CHANGELOG.md.

License

Released under the BSD 3-Clause License.