Dynamsoft Home| Product Home

*******************************
Dynamsoft SAW Standalone Java Command Line Overview
*******************************

In addition to the Java GUI Client, Dynamsoft SAW Standalone also provides a Java Command Line Client. Dynamsoft SAW Standalone Java Command Line supports all the major operations required for source control.

To access Dynamsoft SAW Standalone Java Command Line, use the command prompt. You must use the command line by changing your current folder to the folder where SAWSCmd.jar resides.

Note: Dynamsoft SAW Standalone Java Command Line Client works with Dynamsoft SAW Standalone Professional Server only.



********************
Command Line Syntax
********************

All Dynamsoft SAW Standalone commands entered from the Java command line must begin with "java -jar SAWSCmd.jar".

The syntax for Dynamsoft SAW Standalone commands is as follows:

java -jar SAWSCmd.jar Command [parameter(s)][value(s)]


<Command>

A specific instruction to perform an operation or run a program. The commands in Dynamsoft SAW Standalone are not case-sensitive.

For a complete list of commands in Dynamsoft SAW Standalone Command Line, see Commands and Parameters.

<Parameter>

Used to modify the action of a command. The parameters in Dynamsoft SAW Standalone consist of a hyphen ( - ) and a letter.

For a complete list of parameters in Dynamsoft SAW Standalone Command Line, see Commands and Parameters.

<Values>

Can be a project or a file. The value must follow the parameter letter with a space between them.

If there is a space in any command parameter value, the value must be surrounded by double quotes. For example:

java -jar SAWSCmd.jar GetFileInfo -server 127.0.0.1 -port 8877 -username test -pwd test -tempdir D:\temp -repository "Dynamsoft SAW Standalone" -prj $/123 -file "Text 1.txt"

In almost all cases where you can specify an item to act on, you can also specify many items by adding "/" between them. For example:

java -jar SAWSCmd.jar AddFile -server 127.0.0.1 -port 8877 -username test -pwd test -tempdir D:\temp -repository "Dynamsoft SAW Standalone" -prj $/123 -file Hello.txt/Test.txt



*************************************
Commands and Parameters
*************************************

<Commands>

The following is a list and general description of all the command-line commands.

<Parameters>

The following is a list and description of parameters accepted by Dynamsoft SAW Standalone Java Command
Line. It is necessary to enter full parameter names. If you want to cancel current
operation, type 'c' and then press Enter.

Note: Please put a space between a parameter and the value it acts on.

*******************
Examples
*******************

All examples in this section are based on the following assumptions:

Dynamsoft SAW Standalone Server IP = 127.0.0.1
Dynamsoft SAW Standalone Server Port = 8877
Dynamsoft SAW Standalone Server username = test
Dynamsoft SAW Standalone Server password = test
Dynamsoft SAW Standalone Repository = Dynamsoft SAW Standalone
Project = $/123
Temp folder = "D:\temp"
Working folder = "c:\projects\test"


Example 1: Add a project to the database
----------------------------------------
This adds an entire project located at "c:\projects\new" on the local machine to the project "$/123" in Dynamsoft SAW Standalone repository.

java -jar SAWSCmd.jar AddFolder -server 127.0.0.1 -port 8877 -username test -pwd test
-repository "Dynamsoft SAW Standalone" -workdir c:\projects\new -prj $/123/new -tempdir D:\temp

Example 2: Add a file to project
----------------------------------------
This adds a file "test.txt" to "$/123" project.
java -jar SAWSCmd.jar AddFile -server 127.0.0.1 -port 8877 -username test -pwd test
-repository "Dynamsoft SAW Standalone" -workdir "c:\projects\test" -file "test.txt" -prj $/123 -tempdir "D:\temp"

Example 3: Get a file
---------------------
This places the latest version of the file "test.txt" into the working folder.

java -jar SAWSCmd.jar GetLatestFiles -server 127.0.0.1 -port 8877 -username test -pwd test
-repository "Dynamsoft SAW Standalone" -workdir c:\projects\test -prj $/123 -file text.txt -tempdir D:\temp

Example 4: Get file list
------------------------------
This gets the list of files in the "$/123" project.

java -jar SAWSCmd.jar GetFileList -server 127.0.0.1 -port 8877 -username test -pwd
test -repository "Dynamsoft SAW Standalone" -prj $/123 -tempdir D:\temp

Example 5: Check in a file
---------------------------
This checks in the previously checked out file "test.txt", located on the working
folder at "c:\projects\test".

java -jar SAWSCmd.jar CheckInFile -server 127.0.0.1 -port 8877 -username test -pwd
test -repository "Dynamsoft SAW Standalone" -workdir c:\projects\test -prj $/123 -file test.txt -tempdir D:\temp -comment "Added function HelloWorld"

Example 6: Check out a file
---------------------------
This checks out the latest version of the file "test.txt" and places it into the working folder.

java -jar SAWSCmd.jar CheckOutFile -server 127.0.0.1 -port 8877 -username test -pwd
test -repository "Dynamsoft SAW Standalone" -workdir c:\projects\test -prj $/123 -file test.txt -tempdir D:\temp

Example 7: Label a project
--------------------------
This applies the label "Version 3" to project "$/123" in Dynamsoft SAW Standalone repository.

java -jar SAWSCmd.jar AddLabel -server 127.0.0.1 -port 8877 -username test -pwd test
-repository "Dynamsoft SAW Standalone" -prj $/123 -label "Version 3"

Example 8: Retrieve all files in a project tree by a label
----------------------------------------------------------
This gets a previous version of a project from a label. It retrieves all of the files in the project associated with that label, placing them in the directory
specified by -workdir. It will create directories as needed.

java -jar SAWSCmd.jar GetProject -server 127.0.0.1 -port 8877 -username test -pwd
test -repository "Dynamsoft SAW Standalone" -workdir c:\projects\test -prj $/123 -label "version 1" -tempdir D:\temp

Example 9: Share a project with another project
-----------------------------------------------
This shares the current version of the project "$/123" with the project "$/projects/Dynamsoft SAW Standalone" in Dynamsoft SAW Standalone repository.

java -jar SAWSCmd.jar ShareProject -server 127.0.0.1 -port 8877 -username test -pwd
test -repository "Dynamsoft SAW Standalone" -prj $/123 -shareto $/projects/Dynamsoft SAW Standalone -comment "Sharing project 123 into project Dynamsoft SAW Standalone"

Example 10: Branch a shared file
----------------------------------
This branches files "test.txt" which was previously shared with another files in Dynamsoft SAW Standalone repository.

java -jar SAWSCmd.jar BranchFile -server 127.0.0.1 -port 8877 -username test -pwd test -repository "Dynamsoft SAW Standalone" -prj $/123 -file test.txt

Example 11: Delete a project permanently
----------------------------------------
This deletes project "$/123" permanently from Dynamsoft SAW Standalone repository.

java -jar SAWSCmd.jar Delete -server 127.0.0.1 -port 8877 -username test -pwd test
-repository "Dynamsoft SAW Standalone" -prj $/123 -permanent

Example 12: Put the Command Line Client in an interactive shell
----------------------------------------
This puts the Command Line Client in an interactive shell.
java -jar SAWSCmd.jar Interactive -server 127.0.0.1 -port 8877 -username test -pwd
test -repository "Dynamsoft SAW Standalone" -tempdir D:\Temp

Example 13: Add a file to project in an interactive shell
----------------------------------------
This adds a file to project in an interactive shell.
AddFile -file "test.txt" -prj $/123


**************
Encryption
**************

To enable the Java Command Line Client to connect to the secure port and use encryption, Dynamsoft SAW Standalone Java Client must be installed on the same machine. The Java Command Line Client will use the same User Key that has been imported into the Java Client to authenticate the secure connection.

The Java Command Line Client will use encryption or not depending on the port that it connects to. Please contact your Dynamsoft SAW Standalone Administrator to find out which ports are being used for secure and unsecure connections.