Home » Support » Index of All Documentation » Wing IDE Reference Manual » Command Reference »

Script-provided Add-on Commands

Subversion Commands

Subversion revision control system commands

svn-update (locs=<selected files>)

Update the selected files from the Subversion repository

svn-add ()

Add the files to %(label)s

svn-commit-project ()

Not documented

svn-revert ()

Revert selected files.

svn-project-status ()

View status for entire project.

svn-blame (locs=<selected files>)

Show blame / praise / annotate for selected files.

svn-diff ()

Show differences between files in working directory and last committed version.

svn-diff-recent (locs=<selected files>)

Show diffs for most recent checkin

svn-log (locs=<selected files>)

Show the revision log for the selected files in the Subversion repository

svn-configure ()

Show preferences page for selected VCS

svn-status ()

View status of the selected files in the working directory

svn-remove ()

Remove files

svn-update-project ()

Update files in project

svn-resolved (locs=<selected files>)

Indicate that any conflicts are resolved

svn-checkout ()

Start the initial checkout from svn repository. Repository and working directory must be entered before the checkout.

svn-commit ()

Commit selected files.

Git Commands

git revision control system commands

git-diff ()

Show differences between files in working directory and last committed version.

git-fetch-repository (locs=<selected files>)

Pull from repository.

git-remove ()

Remove files

git-list (locs=<selected files>)

Show the status of the given files in the git repository

git-commit-project ()

Not documented

git-project-status ()

View status for entire project.

git-pull-branch (locs=<selected files>)

Pull branch from other git repository

git-list-branches (locs=<selected files>)

List all branches

git-add ()

Add the files to %(label)s

git-log (locs=<selected files>)

Show the revision log for the selected files in the git repository

git-push-branch (locs=<selected files>)

Push branch to other git repository

git-commit ()

Commit selected files.

git-status ()

View status of the selected files in the working directory

git-switch-branch (locs=<selected files>)

Switch to another branch

git-configure ()

Show preferences page for selected VCS

git-blame (locs=<selected files>)

Show the annotated blame/praise for the selected files in the git repository

Bazaar Commands

Subversion revision control system commands

bzr-commit ()

Commit selected files.

bzr-add ()

Add the files to %(label)s

bzr-commit-project ()

Not documented

bzr-remove ()

Remove files

bzr-project-status ()

View status for entire project.

bzr-status ()

View status of the selected files in the working directory

bzr-push-entire-branch (locs=<selected files>)

Update the selected files from the bzr repository

bzr-log (locs=<selected files>)

Show the revision log for the selected files in the bzr repository

bzr-configure ()

Show preferences page for selected VCS

bzr-revert ()

Revert selected files.

bzr-merge-entire-branch (locs=<selected files>)

Update the selected files from the bzr repository

bzr-annotate ()

Show blame / praise / annotate for selected files.

bzr-diff ()

Show differences between files in working directory and last committed version.

C V S Commands

CVS revision control system commands

cvs-revert (locs=<selected files>)

Revert the selected files

cvs-log (locs=<selected files>)

Show the revision log for the selected files in the CVS repository

cvs-diff (locs=<selected files>)

Show the differences between working version of given files and the corresponding revision in the CVS repository

cvs-configure ()

Configure the CVS integration

cvs-project-status ()

Run status for entire project.

cvs-update (locs=<selected files>)

Update the selected files from the CVS repository

cvs-update-project ()

Update files in project

cvs-checkout ()

Start the initial checkout from cvs repository. Repository and working directory must be entered before the checkout.

cvs-add (locs=<selected files>)

Add the files to cvs

cvs-commit (locs=<selected files>)

Commit the selected files to the CVS repository

cvs-status (locs=<selected files>)

View the CVS repository status for the selected files

cvs-commit-project ()

Commit files in project

cvs-remove (locs=<selected files>)

Remove the selected files

Mercurial Commands

Mercurial revision control system commands

hg-diff ()

Show differences between files in working directory and last committed version.

hg-status ()

View status of the selected files in the working directory

hg-revert ()

Revert selected files.

hg-pull-entire-repository (locs=<selected files>)

Pull all changes from remote repository to local repository

hg-commit ()

Commit selected files.

hg-update (locs=<selected files>)

Update working directory from repository

hg-annotate (locs=<selected files>)

Show user and revision for every line in the file(s)

hg-configure ()

Show preferences page for selected VCS

hg-remove ()

Remove files

hg-add ()

Add the files to %(label)s

hg-log (locs=<selected files>)

Show the revision log for the selected files in the hg repository

hg-push-entire-repository (locs=<selected files>)

Update the selected files from the hg repository

hg-merge (locs=<selected files>)

Merge working directory with changes in repository

hg-commit-project ()

Not documented

hg-project-status ()

View status for entire project.

Perforce Commands

Perforce revision control system commands

perforce-log (locs=<selected files>)

Show the revision log for the selected files in the Perforce repository

perforce-blame (locs=<selected files>)

Show blame / praise / annotate for selected files.

perforce-status (locs=<selected files>)

View the Perforce repository status for the selected files

perforce-commit (locs=<selected files>)

Commit the selected files to the Perforce repository

perforce-remove (locs=<selected files>)

Remove the selected files

perforce-commit-project ()

Commit files in project

perforce-revert (locs=<selected files>)

Revert the selected files

perforce-add (locs=<selected files>)

Add the files to perforce

perforce-sync-project ()

Update files in project

perforce-sync (locs=<selected files>)

Copy the selected files from the Perforce repository

perforce-configure ()

Show preferences page for selected VCS

perforce-edit (locs=<selected files>)

Copy the selected files from the Perforce repository

perforce-project-status ()

Run status for entire project.

perforce-diff (locs=<selected files>)

Show the differences between working version of given files and the corresponding revision in the Perforce repository

perforce-resolved (locs=<selected files>)

Indicate that any conflicts are resolved

perforce-annotate ()

Show blame / praise / annotate for selected files.

Debugger Extensions Script

Scripts that extend the debugger in various ways.

set-breaks-from-markers (app=[])

Scan current file for markers in the form %BP% and places breakpoints on all lines where those markers are found. A conditional breakpoint can be set if a condition follows the marker, for example %BP%:x > 10. Removes all old breakpoints first.

Django Script

A plugin that provides Django-specific functionality when a project looks like it contains Django files.

django-validate ()

Run manage.py validate

django-sql (appname)

Run manage.py sql for given app name and display the output in a scratch buffer.

django-show-docs ()

Show documentation for using Wing IDE and Django together

django-start-project (django_admin, parent_directory, site_name, superuser, superuser_email, superuser_password, pyexec=None)

Start a new Django project with given site name and superuser account. This will prompt for the location of django-admin.py, the parent directory, and the site name to use. It then runs django-admin.py startproject, edits settings.py fields DATABASE_ENGINE and DATABASE_NAME to use sqlite3 by default, adds django.contrib.admin to INSTALLED_APPS in settings.py, runs syncdb/migrate (creating superuser account if one was given), sets up the default admin templates by copying base_site.html into the project, and then offers to create a new project in Wing and run the django-setup-wing-project command to configure the Wing IDE project for use with the new Django project.

django-run-tests-to-scratch-buffer ()

Run manage.py tests with output in a scratch buffer

django-setup-wing-project ()

Sets up a Wing project to work with an existing Django project. This assumes that you have already added files to the project so that your manage.py and settings.py files are in the project. It sets up the Python Executable project property, sets "manage.py runserver 8000" as the main debug file, sets up the Wing project environment by defining DJANGO_SITENAME and DJANGO_SETTINGS_MODULE, adds the site directory to the Python Path in the Wing project, turns on child process debugging (for auto-reload) sets TEMPLATE_DEBUG = True in the settings.py file, ensures that the Template Debugging project property is enabled, sets up the unit testing framework and file patterns in project properties.

django-start-app (appname)

Start a new application within the current Django project and add it to the INSTALLED_APPS list in the project's settings.py file.

django-sync-db ()

Run manage.py syncdb (or migrate in Django 1.8+)

django-run-tests ()

Run manage.py unit tests in the Testing tool

django-restart-shell ()

Show and restart the Python Shell tool, which works in the same environment as "manage.py shell". To show the tool without restarting it, use the Tools menu.

Django Script

A plugin that provides Django-specific functionality when a project looks like it contains Django files.

django-setup-wing-project ()

Sets up a Wing project to work with an existing Django project. This assumes that you have already added files to the project so that your manage.py and settings.py files are in the project. It sets up the Python Executable project property, sets "manage.py runserver 8000" as the main debug file, sets up the Wing project environment by defining DJANGO_SITENAME and DJANGO_SETTINGS_MODULE, adds the site directory to the Python Path in the Wing project, turns on child process debugging (for auto-reload) sets TEMPLATE_DEBUG = True in the settings.py file, ensures that the Template Debugging project property is enabled, sets up the unit testing framework and file patterns in project properties.

django-start-project (django_admin, parent_directory, site_name, superuser, superuser_email, superuser_password, pyexec=None)

Start a new Django project with given site name and superuser account. This will prompt for the location of django-admin.py, the parent directory, and the site name to use. It then runs django-admin.py startproject, edits settings.py fields DATABASE_ENGINE and DATABASE_NAME to use sqlite3 by default, adds django.contrib.admin to INSTALLED_APPS in settings.py, runs syncdb/migrate (creating superuser account if one was given), sets up the default admin templates by copying base_site.html into the project, and then offers to create a new project in Wing and run the django-setup-wing-project command to configure the Wing IDE project for use with the new Django project.

Editor Extensions Script

Editor extensions that also serve as examples for scripting Wing IDE.

set-executable-bit (set_bit=True, doc=[])

Set the current file's executable bit in its permissions. If set_bit is true (the default), the executable bit is set; if set_bit is false, the executable bit is cleared. This doesn't do anything on windows.

toggle-case (editor=[])

Toggle current selection or current word between common name formats: my_symbol_name, MySymbolName, and mySymbolName

fold-python-methods ()

Fold up all Python methods, expand all classes, and leave other fold points alone Key Bindings: Wing IDE: Alt-1; Brief: Alt-1; Eclipse: Alt-1; Emacs: Alt-1; OS X: Command-Alt--; VI/VIM: Alt-1; Visual Studio: Alt-1; XCode: Command-Alt--

word-list-completion (word)

Provide simple word-list driven auto-completion on the current editor

smart-cut ()

Implement a variant of clipboard cut that cuts the whole current line if there is no selection on the editor.

kill-line-with-eol (ed=[])

Variant of emacs style kill-line command that always kills the eol characters

upper-case (editor=[])

Change current selection or current word to all upper case Key Bindings: Eclipse: Ctrl-Shift-Y

smart-copy ()

Implement a variant of clipboard copy that copies the whole current line if there is no selection on the editor.

hyphen-to-under (editor=[])

Change hyphens (dashes) to underscores in current selection or current word

batch-search-current-directory ()

Initial batch search for the current editor['s directory

lower-case (editor=[])

Change current selection or current word to all lower case Key Bindings: Eclipse: Ctrl-Shift-X

cc-checkout (app=[])

Check the current file out of clearcase. This is best used with Wing configured to auto-reload unchanged files.

describe-key-briefly (key)

Display the commands that a key is bound to in the status area. Does not fully work for the vi binding.

insert-spaces-to-tab-stop (tab_size=0)

Insert spaces to reach the next tab stop (units of given tab size or editor's tab size if none is given)

vs-tab (app=[])

Modified tab indentation command that acts like tab in Visual Studio.

vi-fold-more ()

Approximation of zr key binding in vim Key Bindings: VI/VIM: z r

fold-python-classes ()

Fold up all Python classes but leave other fold points alone Key Bindings: Wing IDE: Alt-2; Brief: Alt-2; Eclipse: Alt-2; Emacs: Alt-2; OS X: Command-Ctrl-/; VI/VIM: Alt-2; Visual Studio: Alt-2; XCode: Command-Ctrl-/

vi-fold-less ()

Approximation of zm key binding in vim Key Bindings: VI/VIM: z m

indent-new-comment-line (app=[], ed=[])

Enter a newline, indent to match previous line and insert a comment character and a space. Assumes that auto-indent is enabled.

cursor-home ()

Bring cursor to start of line, to start of visible area, or to start of document each successive consecutive invocation of this command. Key Bindings: Brief: Home

open-filename-from-editor ()

Open the filename at the caret in current editor

open-clicked-url-from-editor ()

Open the url being clicked in the current editor

sort-selected (app=[])

Sort selected lines of text alphabetically

search-python-docs ()

Do a search on the Python documentation for the selected text in the current editor

toggle-mark-command (style='char', select_right=0)

Change between text-marking and non-text-marking mode. Style is "char" for stream select, "block" for rectangular select, and "line" for line select. Set select_right=1 to select the character to right of the cursor when marking is toggled on. Key Bindings: Brief: Alt-M invokes toggle-mark-command(select_right=1)

delete-selected-lines (app=[])

Delete the line or range of lines that contain the current selection. This duplicates what the editor command delete-line does. Key Bindings: Brief: Alt-D

insert-debug-print (app=[])

Insert a print statement to print a selected variable name and value, along with the file and line number.

under-to-hyphen (editor=[])

Change underscores to hyphens (dashes) in current selection or current word

open-url-from-editor ()

Open the url at caret in the current editor

smart-paste (editor=[])

A variant of paste that inserts line just copied with smart-copy above current line.

remove-prompts-and-paste (ed=[])

Paste from clipboard after removing any >>> and ... prompts

convert-to-lf-lineends (app=[])

Convert the current editor to use LF style line endings

close-all-readonly ()

Close all readonly files

insert-text (text)

Insert given text at current caret location, replacing any existing selected text

convert-to-cr-lineends (app=[])

Convert the current editor to use CR style line endings

cursor-end ()

Bring cursor to end of line, to end of visible area, or to end of document each successive consecutive invocation of this command. Key Bindings: Brief: End

title-case (editor=[])

Change current selection or current word to capitalize first letter of each word Key Bindings: Emacs: Alt-C

watch-selection ()

Add a debug watch for the selected text in the current editor

copy-filename-to-clipboard (fn=[])

Copy the filename for the currently selected file to the clipboard

comment-block-toggle ()

Toggle block comment (with ## at start) on the selected lines in editor. This is a different style of block commenting than Wing implements by default (the default in Wing is intended to work better with some of the other editor functionality) Key Bindings: Eclipse: Ctrl-Shift-C

surround (char)

Surround selected text with (), [], {}, "", '', <>, or ``. Arg char should be the opening character. If there is no selection, the current word is surrounded.

System Message: WARNING/2 (<string>, line 700); backlink

Inline literal start-string without end-string.

copy-reference (include_text=True)

Copy 'filename, lineno (scope)' optionally followed by the current line or selected lines to the clipboard. The scope is omitted if there isn't one or in a non-Python file.

open-clicked-filename-from-editor ()

Open the filename being clicked in the current editor

toggle-vertical-split ()

If editor is split, unsplit it and show the vertical tools panel. Otherwise, hide the vertical tools and split the editor left-right Assumes default windowing policy (combined toolbox & editor windows). Thanks to Jonathan March for this script.

convert-to-crlf-lineends (app=[])

Convert the current editor to use CR + LF style line endings

fold-python-classes-and-defs ()

Fold up all Python classes, methods, and functions but leave other fold points alone Key Bindings: Wing IDE: Alt-3; Brief: Alt-3; Eclipse: Alt-3; Emacs: Alt-3; OS X: Command-=; VI/VIM: Alt-3; Visual Studio: Alt-3; XCode: Command-=

toggle-toolbox-separate ()

Toggle between moving the toolboxes to a separate window and the default single-window mode

Emacs Extensions Script

This file contains scripts that add emacs-like functionality not found in Wing's internal emacs support layer.

add-change-log-entry (user_name=None, email=None, changelog=None, changed_file=None, func=None, other_window=False, new_entry=False)

Add a change log entry Key Bindings: Emacs: Ctrl-X 4 A

Pylintpanel Script

PyLint integration for Wing IDE.

pylint-copy-selected-line-number ()

Copy the line number for the currently selected pylint result.

pylint-copy-results ()

Copies all results from the displayed pylint results list.

pylint-package-execute (show_panel=True)

Execute pylint on all files in the package to which the file in the current editor belongs

pylint-show-docs ()

Show the Wing IDE documentation section for the PyLint integration

pylint-copy-selected-message ()

Copy the currently selected pylint result message.

pylint-copy-selected-results ()

Copy the selected pylint results to the clipboard.

pylint-execute (show_panel=True)

Execute pylint for the current editor Key Bindings: XCode: Command-Shift-B

pylint-configure ()

Show the pylint configuration file so it can be edited

Testapi Script

Tests for Wing's scripting API.

test-api (verbose=0)

Test Wing's scripting API

Script-provided Add-on Commands