ADD |
Add files or folders to the repository. | ADDREPOSITORY |
Add a new repository to the server. | ADDUSER |
Add a new user to the server. | BATCH |
Place the command line client in batch mode. | BLAME |
Determine the user that modified a given line. | BRANCH |
Create a branch for a repository folder. | CHECKIN |
Commit items in the pending changeset. | CHECKOUT |
Checkout files from the repository. | CLOAK |
Cloak repository folders. | COMMIT |
Commit items in the pending changeset. | COPYLABEL |
Makes a new label (newlabelname) which is a copy of portion of existing label (srclabelname) found at repositorypath. | CREATEFOLDER |
Create a new folder in the repository. | CREATEHTMLHELP |
Write the contents of all help commands to .\help.htm | CREATE_FCA |
Retrieve an archive file for the differences between two versions of a given folder. | DELETE |
Delete files or folders from the repository. | DELETELABEL |
Delete a label that was applied to a file or folder. | DIFF |
Diff a working file or folder. | FINDINFILES |
Search for a string of characters for the specified files. | FINDINFOLDER |
Search for a string of characters for the files found within a folder. | FORGETLOGIN |
Remove locally stored login information. | GET |
Retrieve files or folders from the repository. | GETLABEL |
Retrieve files or folders specified by label. | GETLABELDIFFS |
This command has been deprecated. Use HISTORY instead. | GETVERSION |
Retrieve files or folder at a specified version. | GETWILDCARD |
Retrieve files whose names match a wildcard. | HELP |
Displays this page or help for a specific command. | HELPHTML |
Displays this page or help for a specific command in HTML format. | HISTORY |
Shows history for an item in the repository. | LABEL |
Applies labelname to version of repositorypath. | LISTCHANGESET |
Show the contents of the pending changeset. | LISTCHECKOUTS |
Show all check out items for the current repository. | LISTFOLDER |
Show contents and status of a repository folder. | LISTOBJECTPROPERTIES |
Show properties of a file or folder on the server. | LISTPROJECTS |
List available work item tracking projects on the server (Vault Professional only). | LISTREPOSITORIES |
List available repositories on the server. | LISTUSERS |
List all users on the server. | LISTWORKINGFOLDERS |
List local working folder associations. | MOVE |
Move a file or folder to a different folder. | OBLITERATE |
Obliterate a deleted item. | PIN |
Pin a file or folder. | REMEMBERLOGIN |
Store authentication information. | RENAME |
Rename a file or folder. | RENAMELABEL |
Rename a file or folder label. | SETWORKINGFOLDER |
Set a working folder association. | SHARE |
Share a file or folder into a different folder. | UNCLOAK |
Uncloak a folder. | UNDOCHANGESETITEM |
Remove an item from the change set. | UNDOCHECKOUT |
Undo checkout (revert changes). | UNPIN |
Unpin a file or folder. | UNSETWORKINGFOLDER |
Remove a working folder association. | VERSIONHISTORY |
Shows version history for a folder in the repository. |
ADD |
usage: vault.exe ADD [options] repositoryfolder localpath ...
ADD will add the files or folders specified by localpath to the repository at the specified repositoryfolder.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -commit Commit this action automatically. |
ADDREPOSITORY |
usage: vault.exe ADDREPOSITORY repositoryname
ADDREPOSITORY will create a new repository on the server named repositoryname.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. |
ADDUSER |
usage: vault.exe ADDUSER username password emailaddress
ADDUSER will create a new user on the server, specified by username, password and emailaddress.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. |
BATCH |
usage: vault.exe BATCH - | filename
Batching allows multiple commands to be executed within one 'run'.
Use - (hyphen) to specify the batch commands can be found on standard input. Otherwise, provide the name of a file where the commands can be located. In batch mode, please provide only one command per line.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. |
BLAME |
usage: vault.exe BLAME repositorypath linenumber [endversion]
BLAME will determine the last user that modified the given line of a file. Optionally, you can specify the version number of the file that the line number references. If no version is specified, the latest version is assumed.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. |
BRANCH |
usage: vault.exe BRANCH [options] repositoryfolder torepositoryfolder
BRANCH will create a branch for the repository folder specified by repositoryfolder at torepositoryfolder.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -commit Commit this action automatically. |
CHECKIN |
usage: vault.exe CHECKIN [options] [repositorypath ...]
COMMIT and CHECKIN will commit the items in the pending changeset list specified by repositorypath(s). If no items are specified on the command line, all items in the pending changeset list are committed.
The "unchanged" option specifies whether unmodified files are checked in.
The "verbose" option provides more information about modified files in the change set which were omitted from the transaction.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -keepcheckedout all files remain checked out upon commit. -unchanged checkin|leavecheckedout|undocheckout Action to perform on an unchanged, checked-out file during commit. Check the file in unmodified, leave the file checked out, or undo the checkout of the file. The default is "undocheckout". -resolvemerge Will resolve merge status on any files which are in a Needs Merge status. |
CHECKOUT |
usage: vault.exe CHECKOUT [options] repositorypath ...
CHECKOUT will checkout files from the repository.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -backup [yes|no] Whether to backup locally modified files before overwriting. If not specified, the user's default value is used. -eol type Mergable files which normally convert to native EOL will be converted to the given line-ending type when fetched. Available types are: "none", "cr", "lf", or "crlf". -exclusive Will check out items exclusively. -merge [automatic|later|overwrite] The action to take when updating a local file with new content. automatic* - attempt to merge changes from the server later - do not overwrite an existing, modified file overwrite - overwrite the local file with the server's file * - only applies to GET and GETWILDCARD commands. -setfiletime checkin|current|modification Sets the time of the local file. checkin - use the last checkin time current - use the current system time modification - use the file's last modified time. -performdeletions [donotremoveworkingcopy|removeworkingcopy| removeworkingcopyifunmodified] When getting a folder, this option controls whether files deleted in the repository are deleted in the working folder. The default is removeworkingcopyifunmodified. -wildcard [wildcard_string] Applies operation only to files that match the wildcard string Use '?' to match a single character or '*' to match a range of characters. -norecursive Do not act recursively on folders. |
CLOAK |
usage: vault.exe CLOAK repositoryfolder ...
CLOAK will cloak a repository folder specified by repositoryfolder, meaning that folder will be ignored during recursive GET operations.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. |
COMMIT |
usage: vault.exe COMMIT [options] [repositorypath ...]
COMMIT and CHECKIN will commit the items in the pending changeset list specified by repositorypath(s). If no items are specified on the command line, all items in the pending changeset list are committed.
The "unchanged" option specifies whether unmodified files are checked in.
The "verbose" option provides more information about modified files in the change set which were omitted from the transaction.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -keepcheckedout all files remain checked out upon commit. -unchanged checkin|leavecheckedout|undocheckout Action to perform on an unchanged, checked-out file during commit. Check the file in unmodified, leave the file checked out, or undo the checkout of the file. The default is "undocheckout". -resolvemerge Will resolve merge status on any files which are in a Needs Merge status. |
COPYLABEL |
usage: vault.exe COPYLABEL [options] repositorypath srclabelname newlabelname [-version version_number] [-labelpath path_of_source_label]
COPYLABEL will create a new copy of an existing label at a specified repository path and version. If no version is specified, the copy of the label is attempted on the current version of the object at repositorypath.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -labelpath identifies the path at which the label in question was created. -version Choose which version of an object is being operated on in the COPYLABEL command. |
CREATEFOLDER |
usage: vault.exe CREATEFOLDER [options] repositorypath
CREATEFOLDER will create a folder in the repository at the point specified by repositorypath.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -commit Commit this action automatically. |
CREATEHTMLHELP |
usage: vault.exe CREATEHTMLHELP
Write the contents of all help commands to .\help.htm
|
CREATE_FCA |
usage: vault.exe CREATE_FCA [options] repositorypath
CREATE_FCA will create a compressed file containing file differences between two versions of a given folder.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -archivefile archive_file A path on the local file system for the archive file of folder changes. -archiveoverwrite Option to overwrite an existing archive file. -norecursive Do not act recursively on folders. -begindate local date [ time] Date to begin history at. -beginlabel labelstring A Label that was applied to the target of the history query. The date of this label will be used to determine the start point of the history query. -enddate local date [ time] Date to end history display at. -endlabel labelstring A Label that was applied to the target of the history query. The date of this label will be used to determine the end point of the history query. -includefiles filename,filename,... A comma-separated list of file names (including wildcards) that will refine the folder search. If not specified, all files are searched. Examples are "file.h,file.hpp"or "*.cpp,*.cs". -excludefiles filename,filename,... A comma-separated list of file names (including wildcards) that will be excluded from the folder search. If not specified, no files will be excluded. Examples are "readme.txt,readme,readme.1st" or "*.cpp,*.cs" -includesummary Include a summary file for the contents of the folder changes archive. |
DELETE |
usage: vault.exe DELETE [options] repositorypath ...
DELETE will delete the files or folders specified by the repositorypath(s) from the repository.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -commit Commit this action automatically. |
DELETELABEL |
usage: vault.exe DELETELABEL repositorypath label_name
DELETELABEL will delete a label that was applied to the input file or folder.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. |
DIFF |
usage: vault.exe DIFF [options] repositorypath
Diff will compare a working file or folder with another file or folder specified by the -compareto option. The working file or folder is specified by its repository path.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -compareto [current|label|lastget|local|repository] [compareto_object] Type of comparison to be made against your local working version. For 'label', 'local', and 'repository', specify the compareto_object, which is a label name, local path or repository path. current - the current repository item label - the version found within the given label lastget - the last version retrieved from the repository local - any local file system item repository- any item within the repository. -norecursive Do not act recursively on folders. -vaultdiff [absolute path to comparison utility] Use this comparison utility for differences. -vaultdiff_options "[any options]" Options for the comparison utility. Use double quotes for multiple options. The following variables will be substituted automatically if you include them: %LEFT_PATH%, %RIGHT_PATH%, %LEFT_LABEL%, %RIGHT_LABEL% The default arguments are: %LEFT_PATH% %RIGHT_PATH% |
FINDINFILES |
usage: vault.exe FINDINFILES [options] searchstring repositorypath_file1 repositorypath_file2 ... repositorypath_filen
FINDINFILES will look for a specific string of characters for the specified files.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -matchcase Search for file contents matched both by the search string and by case. -matchword Search for file contents matched in complete words. -patternmatch [none|wildcard(s)] When searching file contents, this option specifies how the search string characters should be interpretted. Wildcard specifies the search string should allow for special characters - asterisks (*) and question marks (?) in the search string. Note, digits (#) and character sets ([..]) are not supported. |
FINDINFOLDER |
usage: vault.exe FINDINFOLDER [options] searchstring repositorypath
FINDINFOLDER will look for a specific string of characters for the files found in a given folder.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -includefiles filename,filename,... A comma-separated list of file names (including wildcards) that will refine the folder search. If not specified, all files are searched. Examples are "file.h,file.hpp"or "*.cpp,*.cs". -excludefiles filename,filename,... A comma-separated list of file names (including wildcards) that will be excluded from the folder search. If not specified, no files will be excluded. Examples are "readme.txt,readme,readme.1st" or "*.cpp,*.cs" -matchcase Search for file contents matched both by the search string and by case. -matchword Search for file contents matched in complete words. -norecursive Do not act recursively on folders. -patternmatch [none|wildcard(s)] When searching file contents, this option specifies how the search string characters should be interpretted. Wildcard specifies the search string should allow for special characters - asterisks (*) and question marks (?) in the search string. Note, digits (#) and character sets ([..]) are not supported. |
FORGETLOGIN |
usage: vault.exe FORGETLOGIN
FORGETLOGIN will remove all login information being locally stored by the REMEMBERLOGIN command.
|
GET |
usage: vault.exe GET [options] repositorypath ...
GET will retrieve the latest version of files or folders in the repository to the currently defined working folder. Use SETWORKINGFOLDER if there is no working folder, or -nonworkingfolder to retrieve files to a non-working folder.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -backup [yes|no] Whether to backup locally modified files before overwriting. If not specified, the user's default value is used. -eol type Mergable files which normally convert to native EOL will be converted to the given line-ending type when fetched. Available types are: "none", "cr", "lf", or "crlf". -makewritable Make all files writable after retrieval. -makereadonly Make all files read-only after retrieval. -merge [automatic|later|overwrite] The action to take when updating a local file with new content. automatic* - attempt to merge changes from the server later - do not overwrite an existing, modified file overwrite - overwrite the local file with the server's file * - only applies to GET and GETWILDCARD commands. -nocloaks Performs actions on all folders even if they were previously cloaked. -nonworkingfolder localfolder (formerly destpath) Instead of retrieving files to the currently defined working folder, use this folder. Note this does not update state information and you cannot checkin files from a non-working folder. -norecursive Do not act recursively on folders. -performdeletions [donotremoveworkingcopy|removeworkingcopy| removeworkingcopyifunmodified] When getting a folder, this option controls whether files deleted in the repository are deleted in the working folder. The default is removeworkingcopyifunmodified. -setfiletime checkin|current|modification Sets the time of the local file. checkin - use the last checkin time current - use the current system time modification - use the file's last modified time. -workingfolder [disk_path] Retrieve files to working folder specified by disk_path. The working folder specified is temporary, used only for this get request. This option cannot be specified with -nonworkingfolder and only one repositorypath can be specified. |
GETLABEL |
usage: vault.exe GETLABEL [options] repositorypath label [labelpath]
GETLABEL will retrieve files or folders specified by repositorypath at the version at which they were labelled with the specified label. Use -labelworkingfolder (with path) to get the label to a working folder, use -nonworkingfolder (with path) specify a non-working folder. Do not set labelpath unless prompted to.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -backup [yes|no] Whether to backup locally modified files before overwriting. If not specified, the user's default value is used. -eol type Mergable files which normally convert to native EOL will be converted to the given line-ending type when fetched. Available types are: "none", "cr", "lf", or "crlf". -labelworkingfolder localfolder Use localfolder as the working folder for a label get. -makewritable Make all files writable after retrieval. -makereadonly Make all files read-only after retrieval. -merge [automatic|later|overwrite] The action to take when updating a local file with new content. automatic* - attempt to merge changes from the server later - do not overwrite an existing, modified file overwrite - overwrite the local file with the server's file * - only applies to GET and GETWILDCARD commands. -nonworkingfolder localfolder (formerly destpath) Instead of retrieving files to the currently defined working folder, use this folder. Note this does not update state information and you cannot checkin files from a non-working folder. -norecursive Do not act recursively on folders. -setfiletime checkin|current|modification Sets the time of the local file. checkin - use the last checkin time current - use the current system time modification - use the file's last modified time. |
GETLABELDIFFS |
usage: vault.exe GETLABELDIFFS
This command has been deprecated. Use HISTORY instead.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. |
GETVERSION |
usage: vault.exe GETVERSION [options] version item [destination_folder]
GETVERSION will retrieve a file or folder specified by item at the given version. If no destination_folder is specified, the user's current working folder is used. If a destination_folder is specified, item is retrieved into a non-working folder unless the -useworkingfolder option is specified.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -backup [yes|no] Whether to backup locally modified files before overwriting. If not specified, the user's default value is used. -eol type Mergable files which normally convert to native EOL will be converted to the given line-ending type when fetched. Available types are: "none", "cr", "lf", or "crlf". -makewritable Make all files writable after retrieval. -makereadonly Make all files read-only after retrieval. -merge [automatic|later|overwrite] The action to take when updating a local file with new content. automatic* - attempt to merge changes from the server later - do not overwrite an existing, modified file overwrite - overwrite the local file with the server's file * - only applies to GET and GETWILDCARD commands. -nocloaks Performs actions on all folders even if they were previously cloaked. -norecursive Do not act recursively on folders. -setfiletime checkin|current|modification Sets the time of the local file. checkin - use the last checkin time current - use the current system time modification - use the file's last modified time. -useworkingfolder Make the specified destination_folder a working folder for this get. -performdeletions [donotremoveworkingcopy|removeworkingcopy| removeworkingcopyifunmodified] When getting a folder, this option controls whether files deleted in the repository are deleted in the working folder. The default is removeworkingcopyifunmodified. |
GETWILDCARD |
usage: vault.exe GETWILDCARD [options] repositoryfolder wildcard ...
GETWILDCARD will retrieve all files within the folder specified by repositoryfolder whose name matches one of the wildcards specified. You may use '?' to match a single character or '*' to match a range of characters.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -backup [yes|no] Whether to backup locally modified files before overwriting. If not specified, the user's default value is used. -eol type Mergable files which normally convert to native EOL will be converted to the given line-ending type when fetched. Available types are: "none", "cr", "lf", or "crlf". -makewritable Make all files writable after retrieval. -makereadonly Make all files read-only after retrieval. -merge [automatic|later|overwrite] The action to take when updating a local file with new content. automatic* - attempt to merge changes from the server later - do not overwrite an existing, modified file overwrite - overwrite the local file with the server's file * - only applies to GET and GETWILDCARD commands. -nocloaks Performs actions on all folders even if they were previously cloaked. -nonworkingfolder localfolder (formerly destpath) Instead of retrieving files to the currently defined working folder, use this folder. Note this does not update state information and you cannot checkin files from a non-working folder. -norecursive Do not act recursively on folders. -performdeletions [donotremoveworkingcopy|removeworkingcopy| removeworkingcopyifunmodified] When getting a folder, this option controls whether files deleted in the repository are deleted in the working folder. The default is removeworkingcopyifunmodified. -setfiletime checkin|current|modification Sets the time of the local file. checkin - use the last checkin time current - use the current system time modification - use the file's last modified time. |
HELP |
usage: vault.exe HELP [command]
HELP will display a list of all available commands, or detailed help for a specified command.
|
HELPHTML |
usage: vault.exe HELPHTML [command]
HELP will display a list of all available commands, or detailed help for a specified command in HTML format.
|
HISTORY |
usage: vault.exe HISTORY [options] repositorypath
HISTORY will display all committed actions to a file or folder in the repository specified by repositorypath.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -rowlimit limitnumber Limits the number of rows returned for a history query to limitnumber. Defaults to 1000. Set to 0 to retrieve all results. -datesort [asc | desc] Sort the history results in ascending or descending date order. -begindate local date [ time] Date to begin history at. -beginlabel labelstring A Label that was applied to the target of the history query. The date of this label will be used to determine the start point of the history query. -beginversion versionnumber The version number from which history should begin. -enddate local date [ time] Date to end history display at. -endlabel labelstring A Label that was applied to the target of the history query. The date of this label will be used to determine the end point of the history query. -endversion versionnumber The version number from which version history should end. -norecursive Do not act recursively on folders. -includeactions action,action,... A comma-separated list of actions that will be retrieved in the history query. Valid actions to include are: add, branch, checkin, create, delete, label, move, obliterate, pin, propertychange, rename, rollback, share, snapshot, undelete. -excludeactions action,action,... A comma-separated list of actions that will be excluded from the history query. Valid actions to exclude are: add, branch, checkin, create, delete, label, move, obliterate, pin, propertychange, rename, rollback, share, snapshot, undelete. -includeusers user,user,... A comma-separated list of users whose actions are found in the history query. -excludeusers user,user,... A comma-separated list of users whose actions will be excluded from the history query. |
LABEL |
usage: vault.exe LABEL [options] repositorypath labelname [version]
Applies label to version of repositorypath, which can be used later for GETLABEL requests. If no version is specified, the current version is labelled.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: |
LISTCHANGESET |
usage: vault.exe LISTCHANGESET [options]
LISTCHANGESET will display the contents of the pending changeset.
The "verbose" option provides more information about modified files in the change set which will be omitted in a transaction.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: |
LISTCHECKOUTS |
usage: vault.exe LISTCHECKOUTS
LISTCHECKOUTS will display the check out items for the current repository.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. |
LISTFOLDER |
usage: vault.exe LISTFOLDER [options] repositoryfolder
LISTFOLDER will display the contents of the folder specified by repositoryfolder, including the status of any working folders.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -norecursive Do not act recursively on folders. |
LISTOBJECTPROPERTIES |
usage: vault.exe LISTOBJECTPROPERTIES path
LISTOBJECTPROPERTIES will display the properties of the latest version of a file or folder.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. |
LISTPROJECTS |
usage: vault.exe LISTPROJECTS
LISTPROJECTS will list all work item tracking projects on the server.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. |
LISTREPOSITORIES |
usage: vault.exe LISTREPOSITORIES
LISTREPOSITORIES will list all repositories on the server.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. |
LISTUSERS |
usage: vault.exe LISTUSERS [options]
LISTUSERS will list all users on the server.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. This is a list of possible options: -repository repositoryname Repository to connect to. |
LISTWORKINGFOLDERS |
usage: vault.exe LISTWORKINGFOLDERS
LISTWORKINGFOLDERS will list all current associations between repository folders and local working folders.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. |
MOVE |
usage: vault.exe MOVE [options] repositorypath destrepositoryfolder
MOVE will move the file or folder specified by repositorypath into the repository folder specified by destrepositoryfolder.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -commit Commit this action automatically. |
OBLITERATE |
usage: vault.exe OBLITERATE [options] repositorypath
OBLITERATE will permanently remove a deleted folder or file (and all its history) from the repository. You must be logged in as a administrator user to use this command. This command should not be used lightly, as there is no way to undo it.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -yesiamsure This option is required to confirm an Obliterate command. Obliterate is a destructive and non-reversible command that alters the history of the repository. It should not be used lightly. |
PIN |
usage: vault.exe PIN [options] repositorypath [version]
PIN will pin the file or folder specified by repositorypath at the specified version, or latest version if no version specified.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -commit Commit this action automatically. |
REMEMBERLOGIN |
usage: vault.exe REMEMBERLOGIN [options]
REMEMBERLOGIN will store server, repository and authentication information on the local host so that it does not need to be reentered.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. This is a list of possible options: -repository repositoryname Repository to connect to. |
RENAME |
usage: vault.exe RENAME [options] repositorypath destrepositorypath
RENAME will rename a file or folder specified by repositorypath to the new name destrepositorypath.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -commit Commit this action automatically. |
RENAMELABEL |
usage: vault.exe RENAMELABEL [options] repositorypath old_label_name new_label_name
RENAMELABEL will rename a label associated with a file or folder specified by repositorypath.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -commit Commit this action automatically. |
SETWORKINGFOLDER |
usage: vault.exe SETWORKINGFOLDER [options] repositoryfolder localfolder
SETWORKINGFOLDER will set the working folder for the specified repository folder to be the local folder. All future operations on repositoryfolder will use localfolder as a working folder by default.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -forcesubfolderstoinherit Force subfolders to use inherited working folder. |
SHARE |
usage: vault.exe SHARE [options] repositorypath destrepositoryfolder
SHARE will share a file or folder specified by repositorypath into the repository folder specified by destrepositoryfolder.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -commit Commit this action automatically. |
UNCLOAK |
usage: vault.exe UNCLOAK repositoryfolder
UNCLOAK will uncloak specified by repositoryfolder.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. |
UNDOCHANGESETITEM |
usage: vault.exe UNDOCHANGESETITEM changeset item id
UNDOCHANGESETITEM will remove the change set item from the change set list.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. |
UNDOCHECKOUT |
usage: vault.exe UNDOCHECKOUT [options] repositorypath
UNDOCHECKOUT will undo a checkout, reverting changes back to the data in the repository.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -backup [yes|no] Whether to backup locally modified files before overwriting. If not specified, the user's default value is used. -norecursive Do not act recursively on folders. |
UNPIN |
usage: vault.exe UNPIN [options] repositorypath
UNPIN will unpin the file or folder specified by repositorypath.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -commit Commit this action automatically. |
UNSETWORKINGFOLDER |
usage: vault.exe UNSETWORKINGFOLDER [options] repositoryfolder
UNSETWORKINGFOLDER will remove the local working folder association for the specified repositoryfolder.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -recursiveunset Recursively unset the working folders for subfolders. |
VERSIONHISTORY |
usage: vault.exe VERSIONHISTORY [options] repositoryfolder
VERSIONHISTORY will display all versions of a folder in the repository specified by repositoryfolder. Note: -begindate and -enddate options must be used together.
Server and authentication information is specified by: -host host Hostname of the server to connect to. Can also use "-server". -ssl Enables SSL for server connection. -user username Username to use when connecting to server. -password password Password to use when connecting to server. -repository repositoryname Repository to connect to. This is a list of possible options: -rowlimit limitnumber Limits the number of rows returned for a history query to limitnumber. Defaults to 1000. Set to 0 to retrieve all results. -begindate local date [ time] Date to begin history at. -enddate local date [ time] Date to end history display at. -beginversion versionnumber The version number from which history should begin. |