usage: vault commandname [options] [parameters]
This is a list of possible commands:
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 |
CREATEFOLDER | Create a new folder in the repository |
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 |
FOLDERDIFF | Show differences between two repository folders |
FORGETLOGIN | Remove locally stored login information |
GET | Retrieve files or folders from the repository |
GETLABEL | Retrieve files or folders specified by label |
GETLABELDIFFS | Retrieve history for files changed between specified labels. |
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. |
LISTALLBRANCHPOINTS | Show all branch points in the repository |
LISTALLTXDETAILS | List every transaction in the repository with details of its changeset |
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 |
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 |
SOCKET | * VaultAgent.exe only * Accept batch commands on a tcp port. |
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:
|
ADDREPOSITORY |
usage: vault.exe ADDREPOSITORY repositoryname ADDREPOSITORY will create a new repository on the server named repositoryname Server and authentication information is specified by:
|
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:
|
BATCH |
usage: vault.exe BATCH - | filename Batching allows multiple vault 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 vault commands can be located. In batch mode, please provide only one vault command per line. Server and authentication information is specified by:
|
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:
|
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:
|
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. For commits of specific items: You can supply the name of the file(s) or directory(ies) where an action is to be committed. For shares and adds, the commit is located at the destination folder. To distinguish between different actions in one folder, the following syntax is allowed: [directory]?[source_file_or_folder] For example: commit $/destination?$/origin/somefile.txt Server and authentication information is specified by:
Check the file in unmodified, leave the file checked out, or undo the checkout of the file. The default is "undocheckout". |
CHECKOUT |
usage: vault.exe CHECKOUT [options] repositorypath ... CHECKOUT will checkout files from the repository. Server and authentication information is specified by:
specified, the user's default value is used.
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
checkin - use the last checkin time current - use the current system time modification - use the file's last modified time
removeworkingcopyifunmodified]
repository are deleted in the working folder. The default is removeworkingcopyifunmodified.
Use '?' to match a single character or '*' to match a range of characters.
|
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:
|
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. For commits of specific items: You can supply the name of the file(s) or directory(ies) where an action is to be committed. For shares and adds, the commit is located at the destination folder. To distinguish between different actions in one folder, the following syntax is allowed: [directory]?[source_file_or_folder] For example: commit $/destination?$/origin/somefile.txt Server and authentication information is specified by:
Check the file in unmodified, leave the file checked out, or undo the checkout of the file. The default is "undocheckout". |
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:
|
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:
|
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:
|
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:
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
a specific batch or socket command written to a file.
Use double quotes for multiple options. |
FOLDERDIFF |
usage: vault.exe FOLDERDIFF [options] repositoryfolder1 repositoryfolder2 FOLDERDIFF will display the differences between two folders, showing 'left only', 'right only', and 'different'. The compare will be done on version and transaction information only; the contents of the files will not be analyzed. The FOLDERDIFF command is most useful in a setup where the individual files between two folders are shared, but different versions are pinned. If you supply a wildcard, supply it to the first folder. Server and authentication information is specified by:
see (overrides default output). Possible fields for LISTFOLDER: workingfolder,name,version,length,objectid,objectversionid, ispinned,shares,checkouts,status,fullpath,folderversion, txdate,moddate,lastuser,lastaction,lastcomment Possible fields for FOLDERDIFF: name,fullpath,version,moddate,txdate, ispinned,lastuser,lastaction,lastcomment Possible fields for HISTORY: txid,date,name,type,version,user,comment,actionstring, miscinfo1,miscinfo2,affectedfiles If 'affectedfiles' is used, the fullpathname of each file affected by the operation is listed. Shared non-pinned files are listed in CheckIn and RollBack actions, since they are affected too. Possible fields for ANY ACTION: changeset
of the xml output.
a specific batch or socket command written to a file.
limitnumber
right to the highest version between the two. |
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 -destpath to retrieve files to a non-working folder. Server and authentication information is specified by:
specified, the user's default value is used.
this folder. Note this does not update state information and you cannot checkin files from a non-working folder.
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
removeworkingcopyifunmodified]
repository are deleted in the working folder. The default is removeworkingcopyifunmodified.
checkin - use the last checkin time current - use the current system time modification - use the file's last modified time
folder specified is temporary, used only for this get request. This option cannot be specified with -destpath 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 -destpath (with path) specify a non-working folder. Do not set labelpath unless prompted to. Server and authentication information is specified by:
specified, the user's default value is used.
this folder. Note this does not update state information and you cannot checkin files from a non-working folder.
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
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 [options] repositorypath label1 [labelpath2] GETLABELDIFFS will retrieve the histories for all files in the specified repository folder between the specified labels. If only one label is specified, retrieves history from that label to present. Server and authentication information is specified by:
limitnumber
a specific batch or socket command written to a file. |
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:
specified, the user's default value is used.
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
checkin - use the last checkin time current - use the current system time modification - use the file's last modified time
removeworkingcopyifunmodified]
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:
specified, the user's default value is used.
this folder. Note this does not update state information and you cannot checkin files from a non-working folder.
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
removeworkingcopyifunmodified]
repository are deleted in the working folder. The default is removeworkingcopyifunmodified.
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 [options] [command] HELP will display a list of all available commands, or detailed help for a specified command. This is a list of possible options:
a specific batch or socket command written to a file. |
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. Server and authentication information is specified by:
|
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:
limitnumber
The date of this label will be used to determine the start point of the history query.
The date of this label will be used to determine the end point of the history query.
the history query. Valid actions to exclude are: add, branch, checkin, create, delete, label, move, obliterate, pin, propertychange, rename, rollback, share, snapshot, undelete
the history query.
see (overrides default output). Possible fields for LISTFOLDER: workingfolder,name,version,length,objectid,objectversionid, ispinned,shares,checkouts,status,fullpath,folderversion, txdate,moddate,lastuser,lastaction,lastcomment Possible fields for FOLDERDIFF: name,fullpath,version,moddate,txdate, ispinned,lastuser,lastaction,lastcomment Possible fields for HISTORY: txid,date,name,type,version,user,comment,actionstring, miscinfo1,miscinfo2,affectedfiles If 'affectedfiles' is used, the fullpathname of each file affected by the operation is listed. Shared non-pinned files are listed in CheckIn and RollBack actions, since they are affected too. Possible fields for ANY ACTION: changeset
of the xml output.
a specific batch or socket command written to a file. |
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:
|
LISTALLBRANCHPOINTS |
usage: vault.exe LISTALLBRANCHPOINTS [options] LISTALLBRANCHPOINTS will display all branch points in the repository. Server and authentication information is specified by:
a specific batch or socket command written to a file. |
LISTALLTXDETAILS |
usage: vault.exe LISTALLTXDETAILS [options] LISTALLTXDETAILS will display all changesets in the repository. Server and authentication information is specified by:
a specific batch or socket command written to a file. |
LISTCHANGESET |
usage: vault.exe LISTCHANGESET [options] LISTCHANGESET will display the contents of the pending changeset. Server and authentication information is specified by:
a specific batch or socket command written to a file. |
LISTCHECKOUTS |
usage: vault.exe LISTCHECKOUTS [options] LISTCHECKOUTS will display the check out items for the current repository. Server and authentication information is specified by:
a specific batch or socket command written to a file. |
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. After the folder, you can specify a file-name filter, with or without a wildcard. I.e.: $/folder1/try* or $/folder1/tryout.cs. The -norecursive option is also honoured with wildcards. This means that $/*iga* could list $/folder1/origami.cs, but $/*iga* -norecursive could not. Use the exact filename path and -norecursive to get quick info on a single file. Server and authentication information is specified by:
see (overrides default output). Possible fields for LISTFOLDER: workingfolder,name,version,length,objectid,objectversionid, ispinned,shares,checkouts,status,fullpath,folderversion, txdate,moddate,lastuser,lastaction,lastcomment Possible fields for FOLDERDIFF: name,fullpath,version,moddate,txdate, ispinned,lastuser,lastaction,lastcomment Possible fields for HISTORY: txid,date,name,type,version,user,comment,actionstring, miscinfo1,miscinfo2,affectedfiles If 'affectedfiles' is used, the fullpathname of each file affected by the operation is listed. Shared non-pinned files are listed in CheckIn and RollBack actions, since they are affected too. Possible fields for ANY ACTION: changeset
of the xml output.
a specific batch or socket command written to a file.
limitnumber |
LISTREPOSITORIES |
usage: vault.exe LISTREPOSITORIES [options] LISTREPOSITORIES will list all repositories on the server. Server and authentication information is specified by:
a specific batch or socket command written to a file. |
LISTUSERS |
usage: vault.exe LISTUSERS [options] LISTUSERS will list all users on the server. Server and authentication information is specified by:
a specific batch or socket command written to a file.
|
LISTWORKINGFOLDERS |
usage: vault.exe LISTWORKINGFOLDERS [options] LISTWORKINGFOLDERS will list all current associations between repository folders and local working folders. Server and authentication information is specified by:
a specific batch or socket command written to a file. |
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:
|
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:
|
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:
|
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:
|
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:
|
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:
|
SETWORKINGFOLDER |
usage: vault.exe SETWORKINGFOLDER 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:
|
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:
|
SOCKET |
usage: vault.exe SOCKET socketport SOCKET (VaultAgent only) lets you operate the vault command-line client from a tcp socket, on a port you specify. Use 'SOCKET 0' if you only want manual entry of batch commands, in the VaultAgent GUI. Server and authentication information is specified by:
|
UNCLOAK |
usage: vault.exe UNCLOAK repositoryfolder UNCLOAK will uncloak specified by repositoryfolder. Server and authentication information is specified by:
|
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:
|
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:
|
UNPIN |
usage: vault.exe UNPIN [options] repositorypath UNPIN will unpin the file or folder specified by repositorypath. Server and authentication information is specified by:
|
UNSETWORKINGFOLDER |
usage: vault.exe UNSETWORKINGFOLDER repositoryfolder UNSETWORKINGFOLDER will remove the local working folder association for the specified repositoryfolder. Server and authentication information is specified by:
|
VERSIONHISTORY |
usage: vault.exe VERSIONHISTORY [options] repositoryfolder VERSIONHISTORY will display all versions of a folder in the repository specified by repositoryfolder. Server and authentication information is specified by:
limitnumber
a specific batch or socket command written to a file. |