1 Outline
2 Usage
- 2.1 version
3 Syntax
- 3.1 get
  - 3.1.1 allBookmarks
  - 3.1.2 allBundleItems
  - 3.1.3 allBundles
  - 3.1.4 allCommands
  - 3.1.5 allEnvironmentVariables
  - 3.1.6 allGrammars
  - 3.1.7 allPreferences
  - 3.1.8 allSnippets
  - 3.1.9 allSymbols
  - 3.1.10 allTemplates
  - 3.1.11 antiAliasEnabled
  - 3.1.12 autoIndent
  - 3.1.13 bundlePathsForUUID '{uuid="XXX"}'
  - 3.1.14 completionListFor '{prefix="XXX"}'
  - 3.1.15 contentOfWindow '{pathContains="XXX"}'
  - 3.1.16 currentCharacter
  - 3.1.17 currentFontName
  - 3.1.18 currentFontSize
  - 3.1.19 currentGrammarUUID
  - 3.1.20 currentGrammar
  - 3.1.21 currentSpellCheckerLanguage
  - 3.1.22 currentStyleSheet
  - 3.1.23 currentSymbol
  - 3.1.24 currentWordChars
  - 3.1.25 currentWord
  - 3.1.26 defaultBundle
  - 3.1.27 foldingsEnabled
  - 3.1.28 freehandMode
  - 3.1.29 frontMostDocument
  - 3.1.30 hardWrap
  - 3.1.31 hasSelection
  - 3.1.32 indentedPaste
  - 3.1.33 isContinuousSpellCheckingEnabled
  - 3.1.34 isDocumentEdited
  - 3.1.35 lineHead
  - 3.1.36 lineTail
  - 3.1.37 mainScreenSize
  - 3.1.38 openDocumentFiles
  - 3.1.39 openProjectFiles
  - 3.1.40 overwriteMode
  - 3.1.41 positionUnderCaret
  - 3.1.42 selectionXML
  - 3.1.43 showBookmarksInGutter
  - 3.1.44 showLineNumbersInGutter
  - 3.1.45 showSoftWrapInGutter
  - 3.1.46 smartTyping
  - 3.1.47 softTabs
  - 3.1.48 softWrap
  - 3.1.49 standardUserDefaults '{key="XXX"}'
  - 3.1.50 suggestedExtensionForDocument
  - 3.1.51 textString
  - 3.1.52 textXML
  - 3.1.53 uuidFor '{name="XXX"; kind="YYY";}'
  - 3.1.54 windowOriginAndSize
  - 3.1.55 wordHead
  - 3.1.56 wordTail
- 3.2 set
  - 3.2.1 antiAliasEnabled '{to=X;}'
  - 3.2.2 autoIndent '{to=X;}'
  - 3.2.3 bookmarks '{to=(X,Y,...);}'
  - 3.2.4 caretTo '{line=X;index=Y;}'
  - 3.2.5 continuousSpellCheckingEnabled '{to=X;}'
  - 3.2.6 expandSnippetsOnTab '{to=X;}'
  - 3.2.7 foldingsEnabled '{to=X;}'
  - 3.2.8 fontName '{to="XXX";}'
  - 3.2.9 fontSize '{to=X;}'
  - 3.2.10 freehandedEdit '{to=X;}'
  - 3.2.11 frontMostDocument '{to="XXX";}'
  - 3.2.12 grammar '{to="XXX";}'
  - 3.2.13 indentedPaste '{to=X;}'
  - 3.2.14 lineNumbering '{to=X;}'
  - 3.2.15 overwriteMode '{to=X;}'
  - 3.2.16 selectionTo '{line=X;column=Y;length=Z}'
  - 3.2.17 selectionToCurrentScope
  - 3.2.18 showBookmarksInGutter '{to=X;}'
  - 3.2.19 showInvisibles '{to=X;}'
  - 3.2.20 showSoftWrapInGutter '{to=X;}'
  - 3.2.21 smartTyping '{to=X;}'
  - 3.2.22 softTab '{to=X;}'
  - 3.2.23 spellCheckerLanguage '{to=XXX;}'
  - 3.2.24 tabWidth '{to=X;}'
  - 3.2.25 windowOrigin '{x=X;y=Y;}'
  - 3.2.26 windowSize '{width=X;height=Y;}'
  - 3.2.27 wordChars '{to="XXX";}'
- 3.3 move
  - 3.3.1 move caretBy '{line=X;index=Y;}'
  - 3.3.2 move caretToCenter
  - 3.3.3 move selectionBy '{line=X;column=Y;}'
- 3.4 insert
  - 3.4.1 snippet '{value="XXX";}'
  - 3.4.2 text '{value="XXX";}'
- 3.5 call
  - 3.5.1 bundleItem '{uuid="XXX";}'
  - 3.5.2 command '{name="XXX";}'
  - 3.5.3 command PLIST
  - 3.5.4 macro '{name="XXX";}'
  - 3.5.5 macro PLIST
  - 3.5.6 snippet '{name="XXX";}'
  - 3.5.7 template '{name="XXX";}'
- 3.6 goto
  - 3.6.1 nextBookmark
  - 3.6.2 nextSnippetField
  - 3.6.3 prevBookmark
  - 3.6.4 prevSnippetField
- 3.7 show
  - 3.7.1 alertSheet
  - 3.7.2 bundleEditor
  - 3.7.3 bundleMenu
  - 3.7.4 contextMenu
  - 3.7.5 openPanel
  - 3.7.6 printPanel
  - 3.7.7 projectDrawer '{onEdge=X;}'
  - 3.7.8 saveAsPanel
  - 3.7.9 webPreview
- 3.8 close
  - 3.8.1 allAuxiliaryWindows
  - 3.8.2 allFloatingDocumentWindows
  - 3.8.3 allWindows
- 3.9 reload
  - 3.9.1 allBundles
- 3.10 delete
  - 3.10.1 allBookmarks
- 3.11 scroll
  - 3.11.1 columnLeft
  - 3.11.2 columnRight
  - 3.11.3 lineDown
  - 3.11.4 lineUp
  - 3.11.5 windowToCaret
- 3.12 complete
  - 3.12.1 path
  - 3.12.2 usingDictionary
  - 3.12.3 usingDocument
- 3.13 use
  - 3.13.1 nsstring '{initWith="XXX"; toGet="YYY"}'
- 3.14 do
  - 3.14.1 centerWindow
  - 3.14.2 checkUUID '{uuid="XXX";}'
  - 3.14.3 miniaturizeAllWindows
  - 3.14.4 onKeyDownAfterDelay '{delay=T; shell="XXX"; }' or PLIST
  - 3.14.5 openFileInNewWindow
  - 3.14.6 openFileWithFinder
  - 3.14.7 redo
  - 3.14.8 revealFileInFinder
  - 3.14.9 saveCurrentDocument
  - 3.14.10 saveWithFilenameAndReopen '{name="XXX";}'
  - 3.14.11 undo
  - 3.14.12 zoomWindow
- 3.15 help
  - 3.15.1 me
4 Release Notes
- 4.1 Release 0900
- 4.2 Release 0901
- 4.3 Release 0902
- 4.4 Release 0903
- 4.5 Release 0904
- 4.6 Release 0905
- 4.7 Release 0906
5 Contact

1 Outline

The TMTOOLS plug-in is a conglomeration of shell commands which provide the user with advanced functionality to interact with TextMate.

It is based on code fragments of tm_dialog 1.x and 2.x. Furthermore I was inspired by: Allan Odgaard, Joachim Mårtensson, Chris Thomas, Ciarán Walsh, and Håkan Waara.

Important Note:

The TMTOOLS plug-in calls undocumented TextMate functions without an appropriate API.

The usage of that plug-in is at your own risk!

2 Usage

To use the TMTOOLS plug-in write a shell command:

 "$TMTOOLS" verb command {options}
 ... | "$TMTOOLS" verb command -

For help type the following into an empty line of a TextMate document and press CTRL+R

 "$TMTOOLS" help me

The plug-in sets an environment variable “$TMTOOLS” automatically. “TMTOOLS” only interacts with TextMate if you invoke it from a document, meaning this plug-in doesn’t work with the Bundle Editor, Web Preview, etc. in order to avoid unstableness.

options must be written as ‘Property List’. If the property list will be piped to TMTOOLS one has to write a - (a hyphen) to tell TMTOOLS to read the options on STDIN.

Each value given in the Property List will be evaluated as string and converted internally if needed.

2.1 version

In order to get TMTOOLS’ version type

"$TMTOOLS" -v

Bash Example

It checks whether TMTOOLS is installed and if the current version is greater or equal 0906. If not it will download the plug-in.

            if [ -z "$TMTOOLS" ]; then
                open "http://email.eva.mpg.de/~bibiko/downloads/textmate/TMTools.tmplugin.zip"
                exit_discard
            fi

            VERSION=$("$TMTOOLS" -v)

            if [ $VERSION -lt 906 ]; then
                open "http://email.eva.mpg.de/~bibiko/downloads/textmate/TMTools.tmplugin.zip"
                exit_discard
            fi

3 Syntax

3.1 get

In general get asks Textmate for something.

3.1.1 `allBookmarks`

It will list all bookmarks in the current document as property list with line = line number and name = line content.
With the option ‘{format=plain;}’ one gets a plain list: line number:line content
If no bookmarks are set it returns "no bookmarks".
Hint This command manipulates the caret! After the command the caret will be set at the original position automatically.
Examples

            "$TMTOOLS" get allBookmarks
            echo -n "{format=plain;}" | "$TMTOOLS" get allBookmarks -

3.1.2 `allBundleItems`

It will list all bundle items stored in the bundle editor as property list with name and UUID.
With the option ‘{format=plain;}’ one gets a plain list: name TAB UUID
Example

            "$TMTOOLS" get allBundleItems

3.1.3 `allBundles`

It will list all available bundles stored in the bundle editor as property list with name and UUID.
With the option ‘{format=plain;}’ one gets a plain list: name TAB UUID
Example

            "$TMTOOLS" get allBundles

3.1.4 `allCommands`

It will list all available commands stored in the bundle editor as property list with name and UUID.
With the option ‘{format=plain;}’ one gets a plain list: name TAB UUID
Example

            "$TMTOOLS" get allCommands

3.1.5 `allEnvironmentVariables`

It will list all available environment variables as property list with key = name and string = value.
With the option ‘{format=plain;}’ one gets a plain list: name TAB value
With the option ‘{variables=(X,Y,Z);}’ it outputs only the values for the keys X, Y, and Z. If a key does not occur an empty line will be outputted. variables must be an array.
Examples

            "$TMTOOLS" get allEnvironmentVariables '{format=plain;}'
            "$TMTOOLS" get allEnvironmentVariables '{variables=(TM_LINE_NUMBER, TM_SELECTED_TEXT, TM_SCOPE);}'

3.1.6 `allGrammars`

It will list all available grammars stored in the bundle editor as property list with name and UUID.
With the option ‘{format=plain;}’ one gets a plain list: name TAB UUID
Example

            "$TMTOOLS" get allGrammars

3.1.7 `allPreferences`

It will list all available Preferences stored in the bundle editor as property list with name and UUID.
With the option ‘{format=plain;}’ one gets a plain list: name TAB UUID
Example

            "$TMTOOLS" get allPreferences

3.1.8 `allSnippets`

It will list all available snippets stored in the bundle editor as property list with name and UUID.
With the option ‘{format=plain;}’ one gets a plain list: name TAB UUID
Example

            "$TMTOOLS" get allSnippets

3.1.9 `allSymbols`

It will list all available symbols within the current document as property list with name and UUID.
With the option ‘{format=plain;}’ one gets a plain list: line number:line content
Example

            "$TMTOOLS" get allSymbols

3.1.10 `allTemplates`

It will list all available templates stored in the bundle editor as property list with name and UUID.
With the option ‘{format=plain;}’ one gets a plain list: name TAB UUID
Example

            "$TMTOOLS" get allTemplates

3.1.11 `antiAliasEnabled`

Get the boolean value (0/1) for antiAliasEnabled
Example

            "$TMTOOLS" get antiAliasEnabled

3.1.12 `autoIndent`

Get the boolean value (0/1) for autoIndent
Example

            "$TMTOOLS" get autoIndent

3.1.13 `bundlePathsForUUID '{uuid="XXX"}'`

Get all path names of an installed bundle as property list which has the UUID = XXX.
With the option ‘{format=plain;}’ one gets a plain list
With the option ‘{shellEscape;}’ all SPACES are replaced by ‘\ ‘
With the option ‘{urlEscape;}’ all file names are escaped for using them in URLs
With the option ‘{format=mate;}’ all file names are enclosed in single quotes and separeted by SPACES.
Example

            "$TMTOOLS" get bundlePathsForUUID '{uuid="0D42D5EE-5800-40A6-AD0E-29C3F56FAF16";}'

3.1.14 `completionListFor '{prefix="XXX"}'`

It will list all available completion suggestions for the prefix = XXX as property list based on the current WordChars
With the option ‘{format=plain;}’ one gets a plain list
Examples

            "$TMTOOLS" get completionListFor '{prefix="Text"}'
            echo -n "prefix=$TM_CURRENT_WORD;format=plain;" | "$TMTOOLS" get completionListFor -

3.1.15 `contentOfWindow '{pathContains="XXX"}'`

It returns the current content of that document window whose path name contains XXX.
If there are more than one windows opened containing XXX it will return the content of the first opened one.
Example

            "$TMTOOLS" get contentOfWindow '{pathContains="MyDocument"}'

3.1.16 `currentCharacter`

Get the character left of the caret
Example

            "$TMTOOLS" get currentCharacter

3.1.17 `currentFontName`

Get the current font name in the document
Example

            "$TMTOOLS" get currentFontName

3.1.18 `currentFontSize`

Get the current font size in the document
Example

            "$TMTOOLS" get currentFontSize

3.1.19 `currentGrammarUUID`

Get the current UUID for the active grammar used in the document
Example

            "$TMTOOLS" get currentGrammarUUID

3.1.20 `currentGrammar`

Get the current grammar used in the document
Example

            "$TMTOOLS" get currentGrammar

3.1.21 `currentSpellCheckerLanguage`

Get the current spell checker language
Example

            "$TMTOOLS" get currentSpellCheckerLanguage

3.1.22 `currentStyleSheet`

Get the style sheet specified in the current theme as property list
Example

            "$TMTOOLS" get currentStyleSheet

3.1.23 `currentSymbol`

Get the current symbol of the caret’s position
Example

            "$TMTOOLS" get currentSymbol

3.1.24 `currentWordChars`

Get the current WordChars of TextMate’s preferences pane
Example

            "$TMTOOLS" get currentWordChars

3.1.25 `currentWord`

Get the current word relative to the caret
Its behaviour is a bit different from the built-in variable TM_CURRENT_WORD
- If no delimiter is specified it recognizes a word if it is enclosed by SPACES
- With the option delimiter you can specify the word boundaries
- With the option only = head it will output only these characters which are before the caret of the current word
- With the option only = tail it will output only these characters which are after the caret of the current word
Examples

            "$TMTOOLS" get currentWord '{delimiter=" ()";}'
            "$TMTOOLS" get currentWord '{only=head;}'
            "$TMTOOLS" get currentWord '{only=tail;delimiter=" ():.";}'

3.1.26 `defaultBundle`

It returns the user’s home bundle as property list with name and UUID.
With the option ‘{format=plain;}’ one gets a plain list: name TAB UUID
Example

            "$TMTOOLS" get defaultBundle

3.1.27 `foldingsEnabled`

Get the boolean value (0/1) for foldingsEnabled
Example

            "$TMTOOLS" get foldingsEnabled

3.1.28 `freehandMode`

Get the boolean value (0/1) for freehandMode
Example

            "$TMTOOLS" get freehandMode

3.1.29 `frontMostDocument`

Get the file path or the display title (if untitled) of the current front most floating document.
With the option ‘{urlEscape;}’ the file path will be escaped for using it in URLs
Hint This command does not work inside of projects.
Example

            "$TMTOOLS" get frontMostDocument

3.1.30 `hardWrap`

Get the boolean value (0/1) for hardWrap
Example

            "$TMTOOLS" get hardWrap

3.1.31 `hasSelection`

Get the boolean value (0/1) if there is something selected within the current document
Example

            "$TMTOOLS" get hasSelection

3.1.32 `indentedPaste`

Get the boolean value (0/1) for indentedPaste
Example

            "$TMTOOLS" get indentedPaste

3.1.33 `isContinuousSpellCheckingEnabled`

Get the boolean value (0/1) for isContinuousSpellCheckingEnabled
Example

            "$TMTOOLS" get isContinuousSpellCheckingEnabled

3.1.34 `isDocumentEdited`

Get the boolean value (0/1) if the current document is marked as isDocumentEdited
Example

            "$TMTOOLS" get isDocumentEdited

3.1.35 `lineHead`

Get the content of the current line before the caret
Example

            "$TMTOOLS" get lineHead

3.1.36 `lineTail`

Get the content of the current line after the caret
Example

            "$TMTOOLS" get lineTail

3.1.37 `mainScreenSize`

Get the size of the screen as {x, y, width, height}
Example

            "$TMTOOLS" get mainScreenSize

3.1.38 `openDocumentFiles`

Get all accociated file names of all opened document windows as property list.
If a file was not saved yet its display title will outputted
With the option ‘{format=plain;}’ one gets a plain list
With the option ‘{shellEscape;}’ all SPACES are replaced by ‘\ ‘
With the option ‘{urlEscape;}’ all file names are escaped for using them in URLs
With the option ‘{format=mate;}’ all file names are enclosed in single quotes and separeted by SPACES.
Examples

            "$TMTOOLS" get openDocumentFiles
            "$TMTOOLS" get openDocumentFiles '{format=plain;shellEscape;}'
            eval mate `"$TMTOOLS" get openDocumentFiles '{format=mate;}'` untitled

Hint for third example This command forces TextMate to open all floating document windows in a new project even it is only one document (by adding ‘untitled’). If one wants to close all floating windows in beforehand, one can do one of the following:

            L=$("$TMTOOLS" get openDocumentFiles '{format=mate;}')
            "$TMTOOLS" do closeAllFloatingDocumentWindows
            eval mate "$L" untitled

            FRONTMOSTFILE=$("$TMTOOLS" get frontMostDocument '{urlEscape;}')
            eval mate `"$TMTOOLS" get openDocumentFiles '{format=mate;}'` untitled
            open "txmt://open/?url=file://$FRONTMOSTFILE"
            "$TMTOOLS" close allFloatingDocumentWindows
            open "txmt://open/?url=file://$FRONTMOSTFILE"

3.1.39 `openProjectFiles`

Get all file names which are opened in the current project as property list.
Hint This command does not work outside of a project.
With the option ‘{format=plain;}’ one gets a plain list
With the option ‘{shellEscape;}’ all SPACES are replaced by ‘\ ‘
With the option ‘{urlEscape;}’ all file names are escaped for using them in URLs
With the option ‘{format=mate;}’ all file names are enclosed in single quotes and separeted by SPACES.
Example

            "$TMTOOLS" get openProjectFiles
            "$TMTOOLS" get openProjectFiles '{format=plain;urlEscape;}'

3.1.40 `overwriteMode`

Get the boolean value (0/1) for overwriteMode
Example

            "$TMTOOLS" get overwriteMode

3.1.41 `positionUnderCaret`

Get the graphical position under the caret as x,y
Example

            "$TMTOOLS" get positionUnderCaret

3.1.42 `selectionXML`

Get the current scope written as XML for the selection
Example

            "$TMTOOLS" get selectionXML

3.1.43 `showBookmarksInGutter`

Get the boolean value (0/1) for showBookmarksInGutter
Example

            "$TMTOOLS" get showBookmarksInGutter

3.1.44 `showLineNumbersInGutter`

Get the boolean value (0/1) for showLineNumbersInGutter
Example

            "$TMTOOLS" get showLineNumbersInGutter

3.1.45 `showSoftWrapInGutter`

Get the boolean value (0/1) for showSoftWrapInGutter
Example

            "$TMTOOLS" get showSoftWrapInGutter

3.1.46 `smartTyping`

Get the boolean value (0/1) for smartTyping meaning the auto-pair status
Example

            "$TMTOOLS" get smartTyping

3.1.47 `softTabs`

Get the boolean value (0/1) for softTabs
Example

            "$TMTOOLS" get softTabs

3.1.48 `softWrap`

Get the boolean value (0/1) for softWrap
Example

            "$TMTOOLS" get softWrap

3.1.49 `standardUserDefaults '{key="XXX"}'`

Get the value for key in the current standardUserDefaults
Example

            "$TMTOOLS" get standardUserDefaults '{key=OakTextViewNormalFontName;}'

3.1.50 `suggestedExtensionForDocument`

Get the suggested extension for the current document based on the given language
Example

            "$TMTOOLS" get suggestedExtensionForDocument

3.1.51 `textString`

Get the current content of the entire document
Example

            "$TMTOOLS" get textString

3.1.52 `textXML`

Get the current content of the entire document with all scopes written as XML
Example

            "$TMTOOLS" get textXML

3.1.53 `uuidFor '{name="XXX"; kind="YYY";}'`

Get the UUID for the item’s name XXX as YYY.
If XXX = “defaultBundle” and YYY = “bundle” it returns the UUID for the user’s home bundle.
YYY := bundle | command | snippet | language | template | preference | macro
Examples

            "$TMTOOLS" get uuidFor '{name="Lorem ipsum"; kind="snippet";}'
            "$TMTOOLS" get uuidFor '{name="defaultBundle"; kind="bundle";}'

3.1.54 `windowOriginAndSize`

Get the origin and size of the current document’ window as {x,y,width,height}
Example

            "$TMTOOLS" get windowOriginAndSize

3.1.55 `wordHead`

Get all characters of TM_CURRENT_WORD before the caret’s position
Example

            "$TMTOOLS" get wordHead

3.1.56 `wordTail`

Get all characters of TM_CURRENT_WORD after the caret’s position
Example

            "$TMTOOLS" get wordTail

3.2 set

In general set sets something in the current document.

3.2.1 `antiAliasEnabled '{to=X;}'`

X := yes or no
It sets antiAliasEnabled to yes or no
Example

             "$TMTOOLS" set antiAliasEnabled '{to=no;}'

3.2.2 `autoIndent '{to=X;}'`

X := yes or no
It sets autoIndent to yes or no
Example

             "$TMTOOLS" set autoIndent '{to=no;}'

3.2.3 `bookmarks '{to=(X,Y,...);}'`

It sets bookmarks for the lines X,Y,…
The key to must be an array of positive integers
Hint This command manipulates the caret! After the command the caret will be set at the original position automatically.
Example

             "$TMTOOLS" set bookmarks '{to=(5,10,15,20,25);}'

3.2.4 `caretTo '{line=X;index=Y;}'`

Set the caret to line X and character index Y (not column)
If index is not set it places the caret to the beginning of the line X
If index = “end” it places the caret at the end of line X
If line is not set the current line number is used
See also [move caretBy]
Examples

            "$TMTOOLS" set caretTo '{line=2;index=4;}'
            "$TMTOOLS" set caretTo '{index=end;}'
            "$TMTOOLS" set caretTo '{line=2;}'
            "$TMTOOLS" set caretTo '{index=4;}'

3.2.5 `continuousSpellCheckingEnabled '{to=X;}'`

X := yes or no
It sets continuousSpellCheckingEnabled to yes or no
Example

             "$TMTOOLS" set continuousSpellCheckingEnabled '{to=no;}'

3.2.6 `expandSnippetsOnTab '{to=X;}'`

X := yes or no
It sets expandSnippetsOnTab to yes or no
Example

             "$TMTOOLS" set expandSnippetsOnTab '{to=no;}'

3.2.7 `foldingsEnabled '{to=X;}'`

X := yes or no
It sets foldingsEnabled to yes or no
Example

             "$TMTOOLS" set foldingsEnabled '{to=yes;}'

3.2.8 `fontName '{to="XXX";}'`

It sets the current font to XXX
Hint XXX must be a valid font name. Otherwise MAC OSX will set it to a system font.
Example

             "$TMTOOLS" set fontName '{to="Monaco";}'

3.2.9 `fontSize '{to=X;}'`

It sets the current font size to X
X must be a valid integer greater than 1
Example

             "$TMTOOLS" set fontSize '{to=14;}'

3.2.10 `freehandedEdit '{to=X;}'`

X := yes or no
It sets freehandedEdit to yes or no
Example

             "$TMTOOLS" set freehandedEdit '{to=yes;}'

3.2.11 `frontMostDocument '{to="XXX";}'`

Activates that floating document window whose file path or display title (if untitled) is XXX.
With the option ‘{orderFront=no;}’ one activates that document but the displayed document order won’t be changed. Its default is yes.
Relative file paths are omitted.
XXX is case-sensitive.
Hint This command does not work for projects. For projects one can use get openProjectFile 'format=plain;urlEscape;' and TextMate’s URL scheme open "txmt://open/?url=file://$FILENAME"
Fictive Example

            "$TMTOOLS" set frontMostDocument '{to="/Users/TextMate/index.html";}'

3.2.12 `grammar '{to="XXX";}'`

It sets the current grammar, used for syntax highlighting, to XXX
XXX is a valid string for a grammar stored in the bundle editor; if not the command will be ignored
Example

             "$TMTOOLS" set grammar '{to="Plain Text";}'

3.2.13 `indentedPaste '{to=X;}'`

X := yes or no
It sets indentedPaste to yes or no
Example

             "$TMTOOLS" set indentedPaste '{to=no;}'

3.2.14 `lineNumbering '{to=X;}'`

X := yes or no
It sets the line numbering to yes or no
Example

             "$TMTOOLS" set lineNumbering '{to=no;}'

3.2.15 `overwriteMode '{to=X;}'`

X := yes or no
It sets overwriteMode to yes or no
Example

             "$TMTOOLS" set overwriteMode '{to=yes;}'

3.2.16 `selectionTo '{line=X;column=Y;length=Z}'`

Set the selection to line X and column Y from the caret’s position
The values of the keys Line and column could also be negative
If length is set it will select Z characters relative from the caret (could also be negative)
If length is set line and column will be ignored
If line is not set the current line number is used
Examples

            "$TMTOOLS" set selectionTo '{line=2;column=3;}'
            "$TMTOOLS" set selectionTo '{length=-2;}'

3.2.17 `selectionToCurrentScope`

It selects the current scope specified by the caret’s position
Example

             "$TMTOOLS" set selectionToCurrentScope

3.2.18 `showBookmarksInGutter '{to=X;}'`

X := yes or no
It sets showBookmarksInGutter to yes or no
Example

             "$TMTOOLS" set showBookmarksInGutter '{to=yes;}'

3.2.19 `showInvisibles '{to=X;}'`

X := yes or no
It sets showInvisibles to yes or no
Example

             "$TMTOOLS" set showInvisibles '{to=yes;}'

3.2.20 `showSoftWrapInGutter '{to=X;}'`

X := yes or no
It sets showSoftWrapInGutter to yes or no
Example

             "$TMTOOLS" set showSoftWrapInGutter '{to=yes;}'

3.2.21 `smartTyping '{to=X;}'`

X := yes or no
It sets smartTyping — the auto-pair function — temporally for the current document to yes or no
Example

             "$TMTOOLS" set smartTyping '{to=no;}'

3.2.22 `softTab '{to=X;}'`

X := yes or no
It sets softTab to yes or no
Example

             "$TMTOOLS" set softTab '{to=yes;}'

3.2.23 `spellCheckerLanguage '{to=XXX;}'`

It sets the current spell checker language
Example

             "$TMTOOLS" set spellCheckerLanguage '{to=en_GB;}'

3.2.24 `tabWidth '{to=X;}'`

It sets the current used TAB size to X
Example

             "$TMTOOLS" set tabWidth '{to=8;}'

3.2.25 `windowOrigin '{x=X;y=Y;}'`

It sets the current window origin to X, Y (0, 0 := bottom left corner)
Example

             "$TMTOOLS" set windowOrigin '{x=100;y=150;}'

3.2.26 `windowSize '{width=X;height=Y;}'`

It sets the current window size to width X and height Y
Example

             "$TMTOOLS" set windowSize '{width=100;height=200;}'

3.2.27 `wordChars '{to="XXX";}'`

It sets wordChars used for TM_CURRENT_WORD to XXX
Example

             "$TMTOOLS" set wordChars '{to="_$";}'

3.3 move

In general move moves something in the current document.

3.3.1 `move caretBy '{line=X;index=Y;}'`

It moves the caret relative to the actual position
X and Y could also be negative
See also [set caretTo]
Example

             "$TMTOOLS" move caretBy '{index=-2;}'

3.3.2 `move caretToCenter`

It moves the caret to the middle line of the current window
Example

             "$TMTOOLS" move caretToCenter

3.3.3 `move selectionBy '{line=X;column=Y;}'`

It expands the selection relative to the actual caret position
X and Y could also be negative
See also [set selectionTo]
Example

             "$TMTOOLS" move selectionBy '{line=-2;column=-3;}'

3.4 insert

In general insert inserts something in the current document.

3.4.1 `snippet '{value="XXX";}'`

It inserts XXX as snippet
Example

             "$TMTOOLS" insert snippet '{value="\${1:Hello} - \${2:World}\${3:}";}'

3.4.2 `text '{value="XXX";}'`

It inserts XXX as plain text
Example

             "$TMTOOLS" insert text '{value="Hello World";}'

3.5 call

In general call executes an item which is stored as bundle item.

3.5.1 `bundleItem '{uuid="XXX";}'`

It executes any bundle item identified via the internal UUID = XXX
Hint UUIDs depend on the individual TextMate installation and are not system independent
Example

             "$TMTOOLS" call bundleItem '{uuid="DA0A4E77-5F16-11D9-B9C3-000D93589AF6";}'

3.5.2 `command '{name="XXX";}'`

It executes a bundle command with the name XXX
Example

             "$TMTOOLS" call command '{name="Add Line Numbers to Document / Selection";}'

3.5.3 `command PLIST`

It executes that command which is specified in PLIST
Example

            "$TMTOOLS" call command '
                <dict>
                    <key>beforeRunningCommand</key>
                    <string>nop</string>
                    <key>command</key>
                    <string>
                        A=$(cat)
                        echo -e "$A"
                        echo -en "Hello World"
                    </string>
                    <key>input</key>
                    <string>selection</string>
                    <key>fallbackInput</key>
                    <string>word</string>
                    <key>output</key>
                    <string>showAsTooltip</string>
                </dict>
                '

3.5.4 `macro '{name="XXX";}'`

It executes a bundle macro with the name XXX
Example

             "$TMTOOLS" call macro '{name="Delete Line";}'

3.5.5 `macro PLIST`

It executes a dynamic generated macro stored as a property list PLIST
Examples

            "$TMTOOLS" call macro '{
                commands = (
                    {command = "moveWordRight:"; },
                    {command = "moveWordLeftAndModifySelection:"; },
                    {command = "moveWordLeftAndModifySelection:"; },
                    {command = "moveWordLeftAndModifySelection:"; }
                );
            }'

            "$TMTOOLS" call macro '<?xml version="1.0" encoding="UTF-8"?>
            <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/#PropertyList-1.0.dtd">
            <plist version="1.0">
            <dict>
                <key>commands</key>
                <array>
                    <dict>
                        <key>argument</key>
                        <dict>
                            <key>action</key>
                            <string>replaceAll</string>
                            <key>findInProjectIgnoreCase</key>
                            <false/>
                            <key>findString</key>
                            <string>Textmate is good</string>
                            <key>ignoreCase</key>
                            <true/>
                            <key>replaceAllScope</key>
                            <string>document</string>
                            <key>replaceString</key>
                            <string>TextMate is extraordinary</string>
                            <key>wrapAround</key>
                            <true/>
                        </dict>
                        <key>command</key>
                        <string>findWithOptions:</string>
                    </dict>
                </array>
            </dict>
            </plist>
            '

3.5.6 `snippet '{name="XXX";}'`

It executes a bundle snippet with the name XXX
Example

             "$TMTOOLS" call snippet '{name="Lorem ipsum";}'

3.5.7 `template '{name="XXX";}'`

It executes a bundle template with the name XXX
Example

             "$TMTOOLS" call template '{name="From Clipboard";}'

3.6 goto

In general goto goes to an item.

3.6.1 `nextBookmark`

It goes to the next bookmark
Example

             "$TMTOOLS" goto nextBookmark

3.6.2 `nextSnippetField`

It goes to the next snippet field
Example

             "$TMTOOLS" goto nextSnippetField

3.6.3 `prevBookmark`

It goes to the previous bookmark
Example

             "$TMTOOLS" goto prevBookmark

3.6.4 `prevSnippetField`

It goes to the previous snippet field
Example

             "$TMTOOLS" goto prevSnippetField

3.7 show

In general show opens a panel or window.

3.7.1 `alertSheet`

It opens a alert window as sheet bound to the current window.
The returned value is the index beginning with 0 of the pressed button - starting from the right.
Possible options:
- informativeText=”XXX”;
- messageTitle=”XXX”;
- buttonTitles=(“X”,”Y”);
- alertStyle=”XXX”; whereby XXX can be: informational, critical, or warning
Example

             "$TMTOOLS" show alertSheet '{informativeText="This is only a info";
                messageTitle="This is a message";buttonTitles=(OK,Cancel);alertStyle=critical;}'

3.7.2 `bundleEditor`

It opens the Bundle Editor window
Example

             "$TMTOOLS" show bundleEditor

3.7.3 `bundleMenu`

It shows the Bundle Menu (the Gear Menu - CTRL+ESC)
Example

             "$TMTOOLS" show bundleMenu

3.7.4 `contextMenu`

It shows the Context Menu for the current document (right mouse click)
Example

             "$TMTOOLS" show contextMenu

3.7.5 `openPanel`

It opens the internal Open panel
Example

             "$TMTOOLS" show webPreview

3.7.6 `printPanel`

It opens the internal Print panel
Example

             "$TMTOOLS" show printPanel

3.7.7 `projectDrawer '{onEdge=X;}'`

It opens the internal project drawer on a specific edge X
X = 0 : on the left side
X = 1 : at the bottom
X = 2 : on the right side
X = 3 : at the top
Example

             "$TMTOOLS" show projectDrawer '{onEdge=0;}'

3.7.8 `saveAsPanel`

It opens the internal Save As panel
Example

             "$TMTOOLS" show saveAsPanel

3.7.9 `webPreview`

It opens the Web Preview window
Example

             "$TMTOOLS" show webPreview

3.8 close

In general close closes windows.

3.8.1 `allAuxiliaryWindows`

It closes all auxiliary windows which belong to TextMate like the Bundle Editor, Find Panel, HTML Output Windows, etc.
With the option ‘{except=(X,Y,Z);}’ one can specify which auxiliary windows won’t be closed (see example 2).
Examples

             "$TMTOOLS" close allAuxiliaryWindows
             "$TMTOOLS" close allAuxiliaryWindows '{except=(OakFindPanel, OakBundleEditorWindow);}'

3.8.2 `allFloatingDocumentWindows`

It closes all open floating document windows and asks for saving if a document is unsaved. All project windows and auxiliary windows will be untouched.
Example

             "$TMTOOLS" close allFloatingDocumentWindows

3.8.3 `allWindows`

It closes all open windows and asks for saving if a document is unsaved.
Example

             "$TMTOOLS" close allWindows

3.9 reload

In general reload reloads something.

3.9.1 `allBundles`

It reloads all bundles
Example

             "$TMTOOLS" reload allBundles

3.10 delete

In general delete deletes something.

3.10.1 `allBookmarks`

It deletes all bookmarks set in the current document.
Hint This command manipulates the caret! After the command the caret will be set at the original position automatically.
Example

             "$TMTOOLS" delete allBookmarks

3.11 scroll

In general scroll scrolls the window content of the current document.

3.11.1 `columnLeft`

It scrolls the window content one column leftwards
Example

             "$TMTOOLS" scroll columnLeft

3.11.2 `columnRight`

It scrolls the window content one column rightwards
Example

             "$TMTOOLS" scroll columnRight

3.11.3 `lineDown`

It scrolls the window content one line downwards
Example

             "$TMTOOLS" scroll lineDown

3.11.4 `lineUp`

It scrolls the window content one line upwards
Example

             "$TMTOOLS" scroll lineUp

3.11.5 `windowToCaret`

It scrolls the window content to center the selection/caret
Example

             "$TMTOOLS" scroll windowToCaret

3.12 complete

In general complete will show a pull-down menu of suggestions. While typing this list will be updated automatically. This code is mainly taken from Joachim Mårtensson. Changes are only done for the event handling. This pull-down menu will not interfere with tm_dialog.

3.12.1 `path`

It allows the user to input a UNIX path or file name.
If one invokes this completion without a given absolute path at the caret it will start at TM_DIRECTORY resp. at root / if the document is not yet saved.
If one invokes this completion relatively and the parser finds TM_BUNDLE_SUPPORT or TM_SUPPORT_PATH as a valid path before the caret it will start at this position.
Allowed are also relative path names beginning with . or .., and ~ indicating the user’s $HOME directory.
SPACES are escaped automatically.
If one deletes a SPACE it will also delete the according escape sign \.
If the completion finds a distinct path it will complete the path name automatically.
Example

             "$TMTOOLS" complete path

3.12.2 `usingDictionary`

It asks the cocoa’s spell checker dictionary for suggestions for the current word.
As default the language is set to TextMate’s spell checker settings.
To change the language one has to set the key lang accordingly:
- en_US, en_GB, en_AU, en_CA, de, fr, fr_CA, es, it, nl, sv, nb, da, fi, pt are attested
- zh-Hans, zh-Hant, ko, jp are not yet attested
With the option ‘{showInternalListFirst=yes;}’ TextMate’s internal completion list is displayed first. Its default is no.
With the option ‘{autocomplete=yes;}’ the command inserts the longest common prefix of the suggestions automatically. Its default is no.
If no spell checker is found en_US will be used.
Examples

             "$TMTOOLS" complete usingDictionary
             "$TMTOOLS" complete usingDictionary '{lang="de_DE";}'
             "$TMTOOLS" complete usingDictionary '{lang="da";showInternalListFirst=yes;}'

3.12.3 `usingDocument`

It asks TextMate for the suggestions based on the internal document based completion list.
The current word will not be displayed
Example

             "$TMTOOLS" complete usingDocument

3.13 use

In general use is an API to cocoa’s objects.

3.13.1 `nsstring '{initWith="XXX"; toGet="YYY"}'`

This command will init a NSString with the string XXX and returns the method YYY.
If the method asks for an argument one can pass it by using ‘with=”ZZZ”;’
Up to now it supports only NSString methods which requests for none or one argument.
As output types are supported: NSString, NSArray, NSDictionary, NSRange, BOOL, unichar, and int.
Read more for NSString here
Examples

            "$TMTOOLS" use nsstring '{initWith="ö"; toGet="decomposedStringWithCanonicalMapping";}'
            "$TMTOOLS" use nsstring '{initWith="ö"; toGet="decomposedStringWithCanonicalMapping";}'
            "$TMTOOLS" use nsstring '{initWith="hello"; toGet="hasPrefix:"; with="he"; }'
            "$TMTOOLS" use nsstring '{initWith="hello"; toGet="length"; }'
            "$TMTOOLS" use nsstring '{initWith="hello"; toGet="rangeOfString:"; with="el"; }'
            "$TMTOOLS" use nsstring '{initWith="hello"; toGet="smallestEncoding"; }'
            "$TMTOOLS" use nsstring '{initWith="A:B:C"; toGet="componentsSeparatedByString:"; with=":"; }'
            "$TMTOOLS" use nsstring '{initWith="hello"; toGet="compare:"; with="hel"; }'
            "$TMTOOLS" use nsstring '{initWith="たてもの"; toGet="characterAtIndex:"; with="2"; }'
            "$TMTOOLS" use nsstring '{initWith="たてもの"; toGet="canBeConvertedToEncoding:"; with="8"; }'
            "$TMTOOLS" use nsstring '{initWith="/Users/TextMate"; toGet="lastPathComponent";}'
            "$TMTOOLS" use nsstring '{initWith="たてもの"; toGet="stringByAddingPercentEscapesUsingEncoding:"; with="4"; }'
            "$TMTOOLS" use nsstring '{initWith="%E3%81%9F%E3%81%A6%E3%82%82%E3%81%AE";
                            toGet="stringByReplacingPercentEscapesUsingEncoding:"; with="4"; }'
            "$TMTOOLS" use nsstring '{initWith="{z=({a='b';});}"; toGet="propertyList";  }'
            "$TMTOOLS" use nsstring '{initWith="юри"; toGet="caseInsensitiveCompare:"; with="Юри"; }'

3.14 do

In general do executes something or implements an event handler.

3.14.1 `centerWindow`

It centers the current window on the screen.
Example

             "$TMTOOLS" do centerWindow

3.14.2 `checkUUID '{uuid="XXX";}'`

It returns 1 if XXX is not used by TextMate.
It returns 0 if XXX is used by TextMate.
Hint One can generate a new UUID by using the shell command uuidgen.
Example

             "$TMTOOLS" do checkUUID '{uuid="67CBC425-6A5B-4621-97A1-147C8CEC221A";}'

3.14.3 `miniaturizeAllWindows`

It miniaturizes all windows.
Example

             "$TMTOOLS" do miniaturizeAllWindows

3.14.4 `onKeyDownAfterDelay '{delay=T; shell="XXX"; }' or PLIST`

! experimental !
It will execute the shell script XXX or the command which is passed as PLIST after a delay of K seconds after a keyDown event once.
The key stopkey is the integer value of a key event (e.g. 53 = ESC) which interrupts that event handler loop.
If no stopkey is passed the shell command or the command passed via PLIST will be executed only once. After that the keyDown loop handler will interrupt.
If a stopkey is passed and the event handler loop will be interrupted an acoustic signal (Plop) will be played.
With the option ‘passEvent=no;’ the keyDown event will not be sent to TextMate (be carefully). Its default is yes.
If the shell script should be execute repeatedly without a further keyDown event one has to specify ‘repeat=yes;’. Its default is no.
If the shell script should be executed after invoking that command without to wait for the first keyDown event one has to specify ‘startAtCall=yes;’. Its default is no.
It is possible to install more than one keyDown handle, but use it up to now with caution!
Hint Be aware of shell escaping.
Examples

            "$TMTOOLS" do onKeyDownAfterDelay "{delay=2;
                    shell='\"$TMTOOLS\" call command \'{name=\"ShowCurrentScopeToolTip\";}\''; stopkey=53; }"
            "$TMTOOLS" do onKeyDownAfterDelay "{delay="0.5";
                    shell='\"$TMTOOLS\" complete usingDictionary \"{lang=de_DE;}\"'; stopkey=53; }"
            "$TMTOOLS" do onKeyDownAfterDelay "{delay="1.5"; repeat=yes; startAtCall=no;
                    shell='\"$TMTOOLS\" complete usingDocument'; stopkey=53; }"
            "$TMTOOLS" do onKeyDownAfterDelay "{delay="5"; repeat=no; startAtCall=no;
                    shell='\"$TMTOOLS\" get textString > /tmp/\"$TM_FILENAME\".txmtbkp;say \"document was saved\"'; stopkey=53; }"

            "$TMTOOLS" do onKeyDownAfterDelay '
                <dict>
                    <key>delay</key>
                    <string>2</string>
                    <key>beforeRunningCommand</key>
                    <string>nop</string>
                    <key>command</key>
                    <string>
                        A=$(cat)
                        echo -e "$A"
                        echo -en "Hello World"
                    </string>
                    <key>input</key>
                    <string>selection</string>
                    <key>fallbackInput</key>
                    <string>word</string>
                    <key>output</key>
                    <string>showAsTooltip</string>
                </dict>
'

3.14.5 `openFileInNewWindow`

It opens the current project file in a new window.
Example

             "$TMTOOLS" do openFileInNewWindow

3.14.6 `openFileWithFinder`

It opens the current project file with its linked default application.
Example

             "$TMTOOLS" do openFileWithFinder

3.14.7 `redo`

It calls the function redo.
Example

             "$TMTOOLS" do redo

3.14.8 `revealFileInFinder`

It reveals the current project file in Finder.
Example

             "$TMTOOLS" do revealFileInFinder

3.14.9 `saveCurrentDocument`

! Do use that command with care for ‘untitled’ documents !
It will save the current document.
If the document wasn’t saved before — it is an ‘untitled’ document — the ‘Save As Panel’ will be displayed.
For ‘untitled’ documents it is possible to prevent the ‘Save As Panel’ by using the option ‘{avoidPanel;}’. Thus this command will return ‘0’ and the document wont’be saved! If the document was saved successfully it will return ‘1’.
Example

             "$TMTOOLS" do saveCurrentDocument '{avoidPanel;}'

Attention: If one uses that command without the option `avoidPanel` and the current document is an ‘untitled’ document within of a script —not as the last command—, all following commands will be ignored! This also could lead that TextMate freezes and/or some modifications won’t be saved! An other side-effect could be that TextMate registers more than one instance of the same file!
To avoid such a behaviour it is always the best to use the option avaoidPanel and react to the return value.

3.14.10 `saveWithFilenameAndReopen '{name="XXX";}'`

It will save the current floating document window as XXX.
If the document could be saved successfully, it will reopen XXX in TextMate.
If XXX already exists a message will be returned and XXX won’t be overwritten. With the option ‘{overwriteMode;}’ one can force TMTOOLS to overwrite the existing file XXX.
If XXX is not a valid file path or an other error occured only a error message will be returned.
Hint This command won’t work inside of a project.
Examples

             "$TMTOOLS" do saveWithFilenameAndReopen '{name="/Users/TextMate/test.txt";overwriteMode;}'

             FILENAME="$TM_SELECTED_TEXT"
             EXT=$("$TMTOOLS" get suggestedExtensionForDocument)
             filename="$(CocoaDialog filesave --with-directory `dirname "$TM_FILEPATH"` --with-file "$FILENAME.$EXT" )"
             if [ -n "$filename" ]; then
                 echo "{name=\""$filename"\";overwriteMode;}" |"$TMTOOLS" do saveWithFilenameAndReopen -
             fi

3.14.11 `undo`

It calls the function undo.
Example

             "$TMTOOLS" do undo

3.14.12 `zoomWindow`

It zooms the current window.
Example

             "$TMTOOLS" do zoomWindow

3.15 help

3.15.1 `me`

It displays TMTOOLS’ help.
Example

             "$TMTOOLS" help me

4 Release Notes

4.1 Release 0900

first release 08 Oct 2007

4.2 Release 0901

12 Oct 2007
fixed: do onKeyDownAfterDelay only works on a TM text document; not on auxiliary panels etc.
added: to do onKeyDownAfterDelay an option passEvent yes or no
added: to do onKeyDownAfterDelay the possibility not only to execute a shell command but also a command specified by a PLIST
changed: do onKeyDownAfterDelay if no stopkey is given the shell script or the command will only execute once; after that the loop handler does not exist
added: get currentCharacter
added: to call command the possibility not only to call a saved tmCommand via its name but also to pass a plist containing command options
added: do closeAllWindows

4.3 Release 0902

16 Oct 2007
added: to get allEnvironmentVariables an option variables to output only these values
added: close allAuxiliaryWindows
added: close allFloatingDocumentWindows
changed: do closeAllWindows to close allWindows
added: get openDocumentFiles
added: set/get frontMostDocument
added: to get openProjectFiles the output option format=mate;
changed: get openProjectFiles output option escape is renamed to shellEscape
added: do openFileInNewWindow
added: do revealFileInFinder
added: do openFileWithFinder
added: show alertSheet

4.4 Release 0903

24 Oct 2007
added: get contentOfWindow
added: get/set smartTyping
added: get allBundles
added: get uuidFor
added: get defaultBundle
added: get allBundleItems
added: do checkUUID
added: get bundlePathsForUUID

4.5 Release 0904

26 Oct 2007
added: do saveWithFilenameAndReopen
added: get suggestedExtensionForDocument

4.6 Release 0905

26 Oct 2007
added: do saveCurrentDocument

4.7 Release 0906

13 Nov 2007
added: show bundleMenu

5 Contact

If there are further suggestions or bugs don’t hesitate to mail me.

26 October 2007 - Hans-Jörg Bibiko bibiko@eva.mpg.de

Table of Contents