Table of Contents
Since all commands for TortoiseSVN are controlled through command line parameters, you can automate it with batch scripts or start specific commands and dialogs from other programs (e.g. your favourite text editor).
![[Important]](important.png)
|
Important |
|---|---|
|
Remember that TortoiseSVN is a GUI client, and this automation guide shows you how to make the TortoiseSVN dialogs appear to collect user input. If you want to write a script which requires no input, you should use the official Subversion command line client instead. |
The TortoiseSVN GUI program is called TortoiseProc.exe.
All commands are specified with the parameter /command:abcd
where abcd is the required command name. Most of these
commands need at least one path argument, which is given with
/path:"some\path". In the following table the command
refers to the /command:abcd parameter and the path
refers to the /path:"some\path" parameter.
There's a special command that does not require the parameter /command:abcd
but, if nothing is specified on the command line, starts the project monitor instead.
If /tray is specified, the project monitor starts hidden and only
adds its icon to the system tray.
Since some of the commands can take a list of target paths (e.g. committing
several specific files) the /path parameter can take
several paths, separated by a * character.
You can also specify a file which contains a list of paths, separated by
newlines. The file must be in UTF-16 format, without a
BOM
.
If you pass such a file, use /pathfile instead of
/path. To have TortoiseProc delete that file after
the command is finished, you can pass the parameter /deletepathfile.
If you don't pass /deletepathfile, you have to delete the file
yourself or the file gets left behind.
The progress dialog which is used for commits, updates and many more commands usually stays open after the command has finished until the user presses the button. This can be changed by checking the corresponding option in the settings dialog. But using that setting will close the progress dialog, no matter if you start the command from your batch file or from the TortoiseSVN context menu.
To specify a different location of the configuration file, use the parameter
/configdir:"path\to\config\directory".
This will override the default path, including any registry setting.
To close the progress dialog at the end of a command automatically without
using the permanent setting you can pass the /closeonend
parameter.
-
/closeonend:0don't close the dialog automatically -
/closeonend:1auto close if no errors -
/closeonend:2auto close if no errors and conflicts -
/closeonend:3auto close if no errors, conflicts and merges
To close the progress dialog for local operations if there were no
errors or conflicts, pass the /closeforlocal parameter.
The table below lists all the commands which can be accessed
using the TortoiseProc.exe command line. As described above,
these should be used in the form /command:abcd.
In the table, the /command prefix is omitted
to save space.
Table D.1. List of available commands and options
| Command | Description |
|---|---|
| :about | Shows the about dialog. This is also shown if no command is given. |
| :log |
Opens the log dialog. The
An svn date revision can be in one of the following formats:
|
| :checkout |
Opens the checkout dialog. The /path
specifies the target directory and the /url
specifies the URL to checkout from.
If you specify the key /blockpathadjustments,
the automatic checkout path adjustments are blocked.
The /revision:XXX specifies the revision to
check out.
|
| :import |
Opens the import dialog. The /path
specifies the directory with the data to import.
You can also specify the /logmsg switch
to pass a predefined log message to the import dialog.
Or, if you don't want to pass the log message on the
command line, use /logmsgfile:path,
where path
points to a file containing the log message.
|
| :update |
Updates the working copy in /path to
HEAD. If the option /rev is given
then a dialog is shown to ask the user to which
revision the update should go. To avoid the dialog
specify a revision number /rev:1234.
Other options are /nonrecursive,
/ignoreexternals and
/includeexternals.
The /stickydepth indicates that
the specified depth should be sticky, creating
a sparse checkout.
The /skipprechecks can be set
to skip all checks that are done before an update. If this
is specified, then the Show log button
is disabled, and the context menu
to show diffs is also disabled after the update.
|
| :commit |
Opens the commit dialog. The /path specifies the
target directory or the list of files to commit.
You can also specify the /logmsg switch
to pass a predefined log message to the commit dialog.
Or, if you don't want to pass the log message on the
command line, use /logmsgfile:path,
where path
points to a file containing the log message.
To pre-fill the bug ID box (in case you've set up
integration with bug trackers properly), you can use
the /bugid:"the bug id here" to
do that.
|
| :add |
Adds the files in /path to
version control.
|
| :revert |
Reverts local modifications of a working copy.
The /path tells which items
to revert.
|
| :cleanup |
Cleans up interrupted or aborted operations and
unlocks the working copy in /path.
Use /noui to prevent the result
dialog from popping up (either telling about
the cleanup being finished or showing an error message).
/noprogressui also disables the
progress dialog. /nodlg disables
showing the cleanup dialog where the user can
choose what exactly should be done in the cleanup.
The available actions can be specified with the
options /cleanup for status cleanup,
/revert, /delunversioned,
/delignored, /refreshshell
and /externals.
|
| :resolve |
Marks a conflicted file specified in
/path as resolved. If
/noquestion is given, then resolving
is done without asking the user first if it really
should be done.
|
| :repocreate |
Creates a repository in /path
|
| :switch |
Opens the switch dialog. The /path specifies the
target directory and /url the
URL to switch to.
|
| :export |
Exports the working copy in /path
to another directory. If the /path
points to an unversioned directory, a dialog will ask
for an URL to export to the directory in /path.
If you specify the key /blockpathadjustments,
the automatic export path adjustments are blocked.
|
| :dropexport |
Exports the working copy in /path
to the directory specified in /droptarget.
This exporting does not use the export dialog but
executes directly. The option /overwrite
specifies that existing files are overwritten without
user confirmation, and the option /autorename
specifies that if files already exist, the exported
files get automatically renamed to avoid overwriting
them. The option /extended can specify either
localchanges to only export files that
got changed locally, or unversioned
to also export all unversioned items as well.
|
| :dropvendor |
Copies the folder in /path recursively
to the directory specified in /droptarget.
New files are added automatically, and missing files get
removed in the target working copy, basically ensuring
that source and destination are exactly the same.
|
| :merge |
Opens the merge dialog. The /path specifies the
target directory.
For merging a revision range, the following options are available:
/fromurl:URL,
/revrange:string.
For merging two repository trees, the following options are available:
/fromurl:URL,
/tourl:URL,
/fromrev:xxx and
/torev:xxx.
|
| :mergeall |
Opens the merge all dialog. The /path specifies the
target directory.
|
| :copy |
Brings up the branch/tag dialog.
The /path
is the working copy to branch/tag from.
And the /url is the
target URL. If the urls starts with a ^ it is assumed
to be relative to the repository root.
To already check the option
Switch working copy to new branch/tag you can pass
the /switchaftercopy switch. To check the option
Create intermediate folders pass the /makeparents switch.
You can also specify the /logmsg switch
to pass a predefined log message to the branch/tag dialog.
Or, if you don't want to pass the log message on the
command line, use /logmsgfile:path,
where path
points to a file containing the log message.
|
| :settings | Opens the settings dialog. |
| :remove |
Removes the file(s) in /path from
version control.
|
| :rename |
Renames the file in /path. The new
name for the file is asked with a dialog.
To avoid the question about renaming similar files
in one step, pass /noquestion.
|
| :diff |
Starts the external diff program specified in the
TortoiseSVN settings. The /path
specifies the first file.
If the option /path2
is set, then the diff program is started with those
two files. If /path2 is omitted,
then the diff is done between the file in
/path and its BASE. If the specified
file also has property modifications, the external
diff tool is also started for each modified property.
To prevent that, pass the option /ignoreprops.
To explicitly set the revision numbers use
/startrev:xxx and
/endrev:xxx, and for the optional
peg revision use /pegrevision:xxx.
If /blame is set and /path2
is not set, then the diff is done by first blaming
the files with the given revisions.
The parameter /line:xxx specifies the
line to jump to when the diff is shown.
|
| :showcompare |
Depending on the URLs and revisions to compare, this
either shows a unified diff (if the option
The options
If the specified url also has property modifications, the external
diff tool is also started for each modified property.
To prevent that, pass the option |
| :conflicteditor |
Starts the conflict editor specified in the TortoiseSVN
settings with the correct files for the conflicted
file in /path.
|
| :relocate |
Opens the relocate dialog. The /path
specifies the working copy path to relocate.
|
| :help | Opens the help file. |
| :repostatus |
Opens the check-for-modifications dialog. The /path
specifies the working copy directory. If /remote is
specified, the dialog contacts the repository immediately on startup,
as if the user clicked on the Check repository button.
|
| :repobrowser |
Starts the repository browser dialog, pointing to
the URL of the working copy given in
An additional option
If
If |
| :ignore |
Adds all targets in /path to the
ignore list, i.e. adds the svn:ignore
property to those files.
|
| :blame |
Opens the blame dialog for the file specified
in
If the options
If the option
The options |
| :cat |
Saves a file from an URL or working copy path given
in /path to the location given in
/savepath:path. The revision is
given in /revision:xxx. This can
be used to get a file with a specific revision.
|
| :createpatch |
Creates a patch file for the path given in
/path. To skip the file Save-As dialog
you can pass /savepath:path to specify
the path where to save the patch file to directly.
To prevent the unified diff viewer from being started showing
the patch file, pass /noview.
|
| :revisiongraph |
Shows the revision graph for the path given in
To create an image file of the revision graph for a specific path, but
without showing the graph window, pass
Since the revision graph has many options that
affect how it is shown, you can also set the options
to use when creating the output image file.
Pass these options with |
| :lock |
Locks a file or all files in a directory given in
/path.
The 'lock' dialog is shown so the
user can enter a comment for the lock.
|
| :unlock |
Unlocks a file or all files in a directory given in
/path.
|
| :rebuildiconcache |
Rebuilds the windows icon cache. Only use this in
case the windows icons are corrupted. A side effect
of this (which can't be avoided) is that the icons
on the desktop get rearranged.
To suppress the message box, pass /noquestion.
|
| :properties |
Shows the properties dialog for the path given in
For dealing with versioned properties this command requires a working copy.
Revision properties can be viewed/changed if
To open the properties dialog directly for a specific
property, pass the property name as |
| :sync |
Exports/imports settings, either depending on whether the current settings or the exported settings are newer, or as specified.
If a path is passed with
The parameter
If neither
If
If
The parameter |
Examples (which should be entered on one line):
TortoiseProc.exe /command:commit
/path:"c:\svn_wc\file1.txt*c:\svn_wc\file2.txt"
/logmsg:"test log message" /closeonend:0
TortoiseProc.exe /command:update /path:"c:\svn_wc\" /closeonend:0
TortoiseProc.exe /command:log /path:"c:\svn_wc\file1.txt"
/startrev:50 /endrev:60 /closeonend:0