The following is a list and general description of all the command-line commands.
|
Command |
Description |
| About | Displays the version information. |
| Help | List all commands. |
| AddFile | Adds one or multiple files to a folder.
The path of the file on the local machine is specified by the -workdir
parameter. Required Params: -server, -port, -username, -pwd, -teamproject, -folder, -file, -workdir Optional Params: -tempdir, -comment, -notreadonly, -ptype, -pserver, -pport, -puser, -ppwd, - ssl |
| AddFolder | Adds an entire local folder to the
database. The path of the folder on the local machine is specified
by the -workdir parameter. Use -r to add the folder recursively. Required Params: -server, -port, -username, -pwd, -teamproject, -folder, -workdir Optional Params: -tempdir, -comment, -r, -notreadonly, -ptype, -pserver, -pport, -puser, -ppwd, - ssl |
| AddLabel | Adds a label to a folder or a file.
Required Params: -server, -port, -username, -pwd, -teamproject,
-folder,
-label |
| BranchFile | Branch the specified version of a file to a folder. If –rev value is 0, branch the latest version on server, otherwise branch old version. Can use new name.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder, -file，-branchto, -rev Optional Params: - ssl, -newname, -comment, -ptype, -pserver, -pport, -puser, -ppwd |
| BranchFolder | Branch the specified version of a folder to another folder. If –rev value is 0, branch the latest version on server, otherwise branch old version. Can use new name.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder, -branchto, -rev Optional Params: - ssl, -newname, -comment, -ptype, -pserver, -pport, -puser, -ppwd |
| CheckInFile | Checks in and unlocks one or multiple files. This command also makes the local files read-only.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder, -file Optional Params: -comment, -keep,-checkin or -ask or -undo, -notreadonly, -tempdir, -ptype, -pserver, -pport, -puser, -ppwd, - ssl |
| CheckInFolder | Checks in and unlocks an entire folder. This command also makes the local files in the folder read-only. Use -r to check in the folder recursively.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder Optional Params: -comment, -keep, -checkin or -ask or -undo, -notreadonly, -tempdir, -ptype, -pserver, -pport, -puser, -ppwd, - ssl |
| CheckOutFile | Checks out and locks one or multiple files in the same folder. This command also makes the local files writable.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder, -workdir, -file Optional Params: -tempdir, -ask or -skip or -replace,-windows or -unix or -mac, -time, -comment, -ptype, -pserver, -pport, -puser, -ppwd, - ssl |
| CheckOutFolder | Checks out and locks an entire folder. This command also makes the local files in the folder writable. Use -r to checkout a folder recursively.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder，-workdir Optional Params: -tempdir, -r, -ask or -skip or -replace,-windows or -unix or -mac, -time, -comment, -ptype, -pserver, -pport, -puser, -ppwd, - ssl |
| NewFolder | Creates an empty folder in the current team folder. Use -folder to specify the folder path and name.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder Optional Params: - ssl, -comment, -ptype, -pserver, -pport, -puser, -ppwd |
| DeleteFile | Deletes a file from the team folder, while local files still exist on the computer. If the -permanent flag is set, the deleted items cannot be recovered.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder -file Optional Params: -comment, -permanent, -ptype, -pserver, -pport, -puser, -ppwd, - ssl |
| DeleteFolder | Deletes a folder from the team folder, while local files still exist on the computer. If the -permanent flag is set, the deleted items cannot be recovered.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder Optional Params: -permanent, -ptype, -pserver, -pport, -puser, -ppwd, - ssl,-comment |
| GetAllTeamProjects | Lists all accessible team folders by the input server.
Required Params: -server,-port，-username –pwd |
| GetAllUsers | Lists all active users in the current team folder.
Required Params: -server,-port, -username, -pwd, -teamproject |
| GetFileHistory | Displays the revision history of the file.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder, -file Optional Params: -user, -datetime, -ptype, -pserver, -pport, -puser, -ppwd, - ssl |
| GetFileInfo | Displays the current information about a file, including type, version number and modified date.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder, -file Optional Params: -ptype, -pserver, -pport, -puser, -ppwd, - ssl |
| GetFileList | Lists the full name of all files in the
specified folder. Required Params: -server, -port, -username, -pwd, -teamproject, -folder Optional Params: -ptype, -pserver, -pport, -puser, -ppwd, - ssl |
| GetLatestFile | Retrieves the most recent files from the current team folder.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder, -workdir, -file Optional Params: -tempdir, -writable, -ask or -skip or -replace,-time,-windows or -unix or -mac, -ptype, -pserver, -pport, -puser, -ppwd, - ssl |
| GetOldVersionFile | Retrieves the old file version from the current team folder. The -rev parameter is used to specify an old file version.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder, -workdir, -file , -rev or -label Optional Params: -tempdir, -writable, -ask or -skip or -replace,-time,-windows or -unix or -mac, -ptype, -pserver, -pport, -puser, -ppwd, - ssl |
| GetLatestFolder | Gets the latest version of all files in the specified folder from the current team folder. Use -r to get the folder recursively.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder, -workdir |
| GetOlderVersionFolder | Gets the old version of all files in the specified folder from the current team folder. Use -r to get the folder recursively.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder, -workdir,-rev or -label |
| GetFolderHistory | Displays the revision history of the folder. If the -v flag is set, the histories will be shown by version, or it will be shown by item.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder |
| GetFolderTree | Graphically displays the folder structure.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder Optional Params: -ptype, -pserver, -pport, -puser, -ppwd, - ssl |
| Interactive | Puts the Client in an interactive shell, where you can enter commands one after the other, without having to re-run the Command Line Client each time. For example,
SCMSCmd Interactive -server:127.0.0.1 -port:8787 -username test -pwd test -teamproject "Dynamsoft
SCM Anywhere" -tempdir D:\temp
Now you are in the interactive shell. When you use other commands, the parameters -server,-port, -username, -pwd, -teamproject are not required until you type 'quit' to exit interactive shell.
Required Params: -server,-port, -username, -pwd, -teamproject |
| RenameFile | Renames a file in the current team folder.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder, -file, -newname Optional Params: -ptype, -pserver, -pport, -puser, -ppwd, - ssl,-comment |
| RenameFolder | Renames a folder in the current team folder.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder, -newname Optional Params: -ptype, -pserver, -pport, -puser, -ppwd, - ssl,-comment |
| ShareFile | Shares the current version of one files(only one file per time) to a folder, can use new name.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder, -file, -shareto Optional Params:- ssl, -newname, -ptype, -pserver, -pport, -puser, -ppwd |
| UndoCheckOutFile | Cancels the checkout of one or multiple files and reverts to the state before the Check Out operation was performed. This command also makes the local files read-only.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder, -file Optional Params: -tempdir, -windows or -unix or -mac, -time, -notreadonly, -ptype, -pserver, -pport, -puser, -ppwd，-leave or -replace or -del,- ssl |
| UndoCheckOutFolder | Cancels the checkout of a folder and reverts to the state before the Check Out operation was performed. This command also makes the local files read-only. Use -r to undo checkout of the folder recursively.
Required Params: -server,-port, -username, -pwd, -teamproject, -folder Optional Params: -tempdir,-windows or -unix or -mac,-time, -notreadonly, -ptype, -pserver, -pport, -puser, -ppwd，-leave or -replace or -del, - ssl |
The following is a list and description of parameters accepted by Dynamsoft SCM Anywhere Command Line. It is necessary to enter full parameter names. If you want to cancel the current operation, press Ctrl+ 'c'.
Note: Please put a space between a parameter and the value it acts on.
|
Parameter |
Description |
| -branchto | Specifies the folder into which a file or folder will be
branched to.
Used with BranchFile and BranchFolder command. |
| -checkin | Updates the unchanged item to a new version.
Used with CheckInFile and CheckInFolder commands. |
| -comment | Comments on the corresponding operations with
text.
Used with the following commands: AddFile, AddFolder, AddLabel, BrachFile, BranchFolder, CheckInFile ,CheckInFolder, CheckOutFile, CheckOutFolder, NewFolder ,DeleteFile, DeleteFolder, RenameFile, RenameFolder |
| -datetime | Specifies a period of time. By default it's from
the current time to one year ago. You can type two value in the
format "datefrom|dateto", or just one value as the ending
date/time of period which begins from the current time .
Acceptable date/time formats: Used with GetFileHistory or GetFolderHistory commands. |
| -del | Deletes the local copy.
Used with UndoCheckOutFile, and UndoCheckOutFolder commands. |
| -file | Specifies the name of the file(s) in the
team project or the absolute path and full name of the local file(s).
Used with the following commands: AddFile, AddLabel, BranchFile, CheckInFile, CheckOutFile, GetOldVersionFile, GetFileHistory, GetFileInfo, ShareFile, UndoCheckOutFile, BranchFile. |
| -h | Displays help at the command prompt.
Available for all commands. |
| -keep | Keeps checkout status after the check-in
operation.
Used with CheckInFile and CheckInFolder commands. |
| -label | Specifies a label that can be associated with a
particular folder version or file version.
Used with GetOlderVersionFolder, GetOldVersionFile, AddLabel command. |
| -leave | Leaves the local copy alone.
Used with UndoCheckOutFile and UndoCheckOutFolder commands. |
| -mac | Uses Mac EOL for files.
Used with the following commands: CheckOutFile, CheckOutFolder, GetLatestFile, GetOldVersionFile, GetLatestFolder, GetOlderVersionFolder, UndoCheckOutFile, UndoCheckOutFolder |
| -newname | Specifies a new name for the folder or file that
is being renamed.
Used with the RenameFile, RenameFolder, ShareFile, BranchFile, BranchFolder commands. |
| -notreadonly | Doesn't change the file attribute to read-only.
Used with the following commands: AddFile, AddFolder, CheckInFolder, CheckInFile, UndoCheckOutFolder and UndoCheckOutFile. |
| -permanent | Permanently deletes a file or folder from the
database.
Used with the DeleteFile, DeleteFolder command. |
| -port | Specifies the port of a running Dynamsoft SCM
Anywhere server. A must for all commands. |
| -pport | Specifies the port of the proxy server.
Needed when the proxy server is used. |
| -ppwd | Specifies the password for the corresponding user
to connect to the proxy server.
Needed when the proxy server is used. |
| -folder | Specifies a valid folder in the current Dynamsoft
SCM Anywhere team project.
A must for all commands except About, Help, GetAllTeamProjects, GetAllUsers and Interactive. |
| - ssl | Specifies whether to connect to server using SSL encryption. |
| -pserver | Specifies the domain name or IP address of the
proxy server. If ptype = "None", this parameter is invalid and not
required.
Needed when the proxy server is used. |
| -ptype | Specifies the proxy type. Valid -ptype parameters
are "None" and "Http", the default value is
"None".
Needed when the proxy server is used. |
| -puser | Specifies the user name used to connect to the
proxy server. If ptype = "None", this parameter is
invalid and not required.
Needed when the proxy server is used. |
| -pwd | Specifies the password for the corresponding user
to log into Dynamsoft SCM Anywhere team project.
A must for all commands except GetAllTeamProjects. |
| -r | Performs the folder level command recursively.
Used with the following commands: GetOlderVersionFolder, GetLatestFolder, CheckOutFolder, AddFolder |
| -replace | Replaces the local copy with file(s) in the
team project.
Used with the following commands: CheckOutFile, GetLatestFile, GetOldVersionFile, GetLatestFolder, GetOlderVersionFolder, CheckOutFolder, UndoCheckOutFile and UndoCheckOutFolder. |
| -teamproject | Specifies the team folder you want to log into.
A must for all commands except GetAllTeamProjects. |
| -rev | Specifies a version number of the file.
Used with GetOlderVersionFolder, GetOldVersionFile, BranchFolder, BranchFile. |
| -skip | Leaves the local copy alone (doesn't retrieve the
latest version from the team project).
Used with the following commands: GetLatestFolder, GetOlderVersionFolder, GetOldVersionFile, GetLatestFile, CheckOutFolder, CheckOutFile |
| -server | Specifies the domain name or IP address of a
running Dynamsoft SCM Anywhere server.
A must for all commands. |
| -shareto | Specifies the folder into which a file will be shared.
Used with ShareFile command. |
| -tempdir | Specifies a local folder for storing temporary
files.. The default temporary directory is specified in the
ServerInfo->General Settings section of Dynamsoft SCM Anywhere
Service Configurator (for Java Command Line, the default temporary
directory is the system temporary directory).
Used with the following commands: UndoCheckOutFolder, UndoCheckOutFile, Interactive, GetOlderVersionFolder, GetLatestFolder, GetOldVersionFile, GetLatestFile, CheckOutFolder, CheckOutFile, CheckInFolder, CheckInFile, AddLabel, AddFolder, AddFile |
| -time | Sets the modification time of the local file or
folder. Valid time parameters are "current" (default), "modi" and
"checkin". modi - The item's last modified time. current - Current time. checkin- The item's last checked in time. Examples: -time modi or -time current or -time checkin. Used with the following commands: UndoCheckOutFolder,
UndoCheckOutFile, GetOlderVersionFolder, GetLatestFolder, |
| -undo | Undoes the checkout without updating to a new
version.
Used with CheckInFile and CheckInFolder commands. |
| -unix | Uses Unix EOL for files.
Used with the following commands: AddFile, AddFolder, CheckInFile, CheckInFolder, CheckOutFile, CheckOutFolder, GetLatestFiles, GetOldVersionFile, GetFolder, UndoCheckOutFile, and UndoCheckOutFolder. |
| -user | Specifies an existing username.
Used with GetFileHistory and GetFolderHistory commands. |
| -username | Specifies the user name used to log into Dynamsoft
SCM Anywhere.
A must for all commands except About and Help. |
| -v | Shows the folder histories by version.
Used with the GetFolderHistory command. |
| -windows | Uses Windows EOL for files.
Used with the following commands: AddFile, AddFolder, CheckInFile, CheckInFolder, CheckOutFile, CheckOutFolder, GetLatestFiles, GetOldVersionFile, GetFolder, UndoCheckOutFile, and UndoCheckOutFolder. |
| -writable | Makes the local files writable.
Used with GetLatestFile, GetOldVersionFile, GetLatestFolder, GetOlderVersionFolder. |
| -workdir | Specifies the working folder from which the
Command Line Client finds or places items. By default it's
Dynamsoft SCM Anywhere Command Line directory.
Used with the following commands: GetOlderVersionFolder, GetLatestFolder, GetOldVersionFile, GetLatestFile, CheckOutFolder, CheckOutFile, AddFolder, AddFile |
Software Configuration Management | SCM Solution | Version Control Software |Source Control Software
Software Configuration Management Hosting |Online Software Configuration Management |SCM Hosted
Copyright © 2009 Dynamsoft Corporation. All Rights Reserved.