Add Files: add

Use add to add files to a project from the command line.

You can simultaneously link the added files to a process item. All the files successfully added using this command will be linked and pinned to the tip revision of the process item. Use the -active option to specify the currently active process item (previously set using a StarTeam client on your workstation).

If no item is active or you prefer to use another item, use the option that indicates the type of the process item (-cr, -req, or -task), followed by the complete path from the root folder of the StarTeam project view to the item, using the forward slash (/) as a delimiter between folder names. For out-of-view process items, specify the project name and view name in front of the complete folder path. Separate the view path with a colon (:). For example, -cr MyProject/RootView:ChildView/SourceCode/37 specifies change request 37 in the SourceCode folder of the ChildView view in the MyProject project. During execution, the process first assumes that the process item is in the current view, and it checks the current view to determine whether the full path corresponds to a folder path within that view. If the process item is not found in the current view, it is treated as an out-of-process item, and the search for the process item begins from the project and view.

Use the -mark option to simultaneously mark the process item as fixed, finished, or complete, depending on its type. A StarTeam Server transaction processes the files selected to add. They succeed or fail together. Additionally, StarTeam creates a check in change package in the target view.

Syntax

The syntax for this command is:

stcmd{Ex} add  [[-p "projectSpecifier"] [-epwdfile "filePath"]
[-cmp] [-csf] [-encrypt encryptionType] ][-is] [-nivf] [-rp "folderPath"
| -fp "folderPath] [-l | -u | -nel] [-ro | -rw]] [-d "description" 
| -rf "fileName"] [-vl "labelName] [[ -active | 
[-cr | -req | -task] processItemPath] [-cp "name"] [-mark]] 
[-q -pf "filterName"] [-ofp "resultsOutputFilePath"][files...]
Parameter
Description
-p
Indicates the view or folder to be used. It also provides the user name and password needed to access the server. -p is retained for backward compatibility. Commands using -p continue to work, but are stateless. Each command opens a connection, executes the command syntax, and closes the connection. (New command line scripts may take advantage of the command line's stateful nature. See connect and set for examples. Old scripts may be migrated to the new command line syntax.) Stateless commands cause more client server traffic than stateful commands.
Note: If the clear text password contains the @ or the : symbols, then it cannot be specified through -p using the syntax username:password@host:port. The @ or :symbols will conflict with the syntax and cause the command to fail. In general, passwords with special characters in them such as @, :, ,, must be stored in the password file using the store-password command. Additionally, the password, when specified for storage in the encrypted file, must be quoted. For example: stcmd store-password -password "foo@bar" -epwdfile c:\tmp\pwdfl. Passwords stored in an encrypted password file can be used in conjunction with -p or the connect command as documented.

The full syntax is:

stcmd -p "userName:password@hostName:endpoint/projectName/[viewName/][folderHierarchy/]"

For example:

stcmd -p “bsmith:rocketfive@orion:49201/StarDraw/StarDraw/SourceCode/”
  • If the user name is omitted, the current user name is used.
  • If the password is omitted, the user is prompted to enter the password. When the user types a password, the characters are not displayed on the screen.
  • If the host name is omitted, the default is localhost.
  • Entering an endpoint (port number) is required. The default is 1024.
  • The project name is always required.
  • A view hierarchy should be used to identify the view. Use the colon (:) as a delimiter between view names. The view hierarchy should always include the root view. For example, "StarDraw:Release 4:Service Packs" indicates that the view to be used is the Service Packs view, which is a child of the Release 4 view and a grandchild of the StarDraw root view. If the view name is omitted, the root view is used. If the view is the only view in that project with that name, you can use only the view name. Doing this is not recommended, however, because another view with that name could be created at a later date.
  • A folder hierarchy should be used to identify the folder. Use the forward slash (/) as a delimiter between folder names. The folder hierarchy never includes the root folder. Omit the folder hierarchy if the file is in the view’s root folder. For example, if the root folder of the view is StarDraw, and the hierarchy to your files is StarDraw/SourceCode/Client, use only "SourceCode/Client".
-epwdfile

The -epwdfile keyword specifies the path to the file that contains the encrypted password. Like -pwdfile , -epwdfile replaces the password being used as part of the -p or -s option, preventing others from seeing the user's password on the command line. The full syntax is: -epwdfile "filePath" .

The -pwdfile is supported for backward compatibility. Un-encrypted passwords stored using older versions of stcmd are read. However, passwords cannot be stored to files using -pwdfile anymore.

Note: When -epwdfile is used, a password should not be specified as part of the -p or -sparameter.

In this case, the syntax of -p or -s reduces to -p "username@hostname:port/... -epwdfile "fullyQualifiedPathToPasswordFile"".

The following is the syntax of the commands that can be used to store an encrypted password.

Use the following syntax to be prompted for the password that will be encrypted and stored in a file.

stcmd store-password -epwdfile "filePath"
Use the following syntax to include the encrypted password in the command as clear text.
Note: This action does not access the network with the clear value.
stcmd store-password -epwdfile "filePath" -password "password"

After an encrypted password is stored, other stcmd commands can specify -epwdfile "filePath"' as parameters. For example:

stcmd delete-local -p "JMarsh@Orion:1024/StarDraw/StarDraw/SourceCode" -epwdfile "C:\estuff\myfile.txt" -filter "N" "*"
Important:

If -p or -s and -epwdfile are used together, then the parameter :password must be omitted from -p. For example:

-p user@hostname:port/projectName.viewName -epwdfile "pathToPasswordFile"
-cmp

Compresses all the data sent between the workstation and the server and decompresses it when it arrives. Without this option, no compression takes place.

Compression speeds transmission across the network, but it takes time on the front end to compress the data and at the back end to decompress the data.

This is an optional parameter. If not specified, then the platform default is not to compress.

-csf

When the command maps the folder specified in the -p option to the underlying StarTeam folder, using -csf causes the command to differentiate StarTeam folders based on the case-sensitive spelling of their names This option does not apply to the case-sensitivity of filenames in the folders. For example, with -csf, StarTeam folders named doc and Doc are recognized as different folders. Without this option, either folder could be recognized as the doc folder.

The default is that StarTeam folders are not differentiated based on the case of letters in their names.

With or without -csf, if folder names are ambiguous, an error occurs. For example, when you use -csf, the names of two folders are ambiguous if both a Doc and doc folder exist. When you do not use -csf, folder names are ambiguous if they are spelled identically.

-encrypt

Encrypts all data sent between the workstation and the server and decrypts it when it arrives. Without this option, no encryption takes place. Encryption protects files, data and other project information from being read by unauthorized parties over unsecured networks.

This is an optional parameter. If not specified, then the server and the command line negotiate the encryption required by the server.

The full syntax is: -encrypt encryptionType.

The types of encryption are:

RC4
RSA RC4 stream cipher (fast).
RC2_ECB
RSA RC2 block cipher (Electronic Codebook).
RC2_CBC
RSA RC2 block cipher (Cipher Block Chaining).

These encryption types are ordered from fastest to slowest. Each of the slower encryption types is safer than the one preceding it.

Note: For platforms other than Microsoft Windows, the public and private keys used in the encryption process are not created automatically. They are stored in a file in the user’s home directory. This options file is named .starteam. It contains a variable or shell variable called keyfile. The keyfile variable specifies the location of the file that contains the public and private keys. If you do not specify the keyfile variable, an error occurs. When you specify the keyfile variable, but the file does not exist, the StarTeam Cross-Platform Client generates a random pair of keys, creates the file, and stores the keys in it. Be sure to secure this file. For example, in UNIX, only its owner should be able to read it.
-is
Applies the command to all child folders. Without this option, the command applies only to the specified folder. When this option is used with add-folder, you can add an entire branch of folders to the StarTeam folder hierarchy.

When used with add or ci, the command recursively visits all modified files in all sub-folders and checks them in.

-nivf
If -nivf is included, then files in Not in View folders are also included in the action.
-rp

Overrides the working folder or working directory for the StarTeam view’s root folder.

While this option allows you to use a different working folder than the one specified by the StarTeam view, its critical importance is to provide cross-platform compatibility. For example, UNIX and Microsoft Windows systems specify drive and directory path names in incompatible ways.

While the path D:\MYPRODUCT\DEVELOPMENT\SOURCE is understood on a Microsoft Windows platform, it is not understood on a UNIX platform. Use this option to define the working path if your platform does not understand the path specified in the StarTeam project.

The UNIX shell interprets a backslash (\) as an escape character when it precedes certain characters, such as quotation marks. As a result, an error occurs in the following example:

stcmd ci -p "xxx" -rp "C:\" "*"

which is interpreted as:

stcmd ci -p "xxx" -rp "C:" *"

To avoid a situation like this, escape the final character in "C:\" as follows:

stcmd ci -p "xxx" -rp "C:\\" "*"

Or avoid it as follows when the -rp path doesn’t end with the root folder as in "C:\orion\":

stcmd ci -p "xxx" -rp "C:\orion" "*"

The full syntax is: -rp "folderName" .

Folder is the Microsoft Windows term and appears in the StarTeam user interface. Directory is the correct term for the UNIX platform.

-fp

Overrides the specified StarTeam folder’s working folder or working directory. This is equivalent to setting an alternate working path for the folder.

While this option allows you to use a different working folder than the one specified by the StarTeam view, its critical importance is to provide cross-platform compatibility. For example, UNIX and Microsoft Windows systems specify drive and directory path names in incompatible ways.

While the path D:\MYPRODUCT\DEVELOPMENT\SOURCE is understood on a Microsoft Windows platform, it is not understood on a UNIX platform. Use this option to define the working path if your platform does not understand the path specified in the StarTeam project.

A backslash (\) is interpreted as an escape character when it precedes quotation marks. As a result, an error occurs in the following example:

stcmd ci -p "xxx" -fp "C:\" "*"

which is interpreted as:

stcmd ci -p "xxx" -fp "C:" *"

To avoid a situation like this, escape the final character in "C:\" as follows:

stcmd ci -p "xxx" -fp "C:\\" "*"

Or avoid it as follows when the -rp path doesn’t end with the root folder as in C:\orion\:

stcmd ci -p "xxx" -fp "C:\orion" "*"

The full syntax is: -rp "folderName".

Folder is the Microsoft Windows term and appears in the StarTeam user interface. Directory is the correct term for the UNIX platform.

-l | -u | -nel
Locks the item(s). -l is exclusive lock, -u is unlocked, and -nel is non exclusive lock. These items are mutually exclusive and an optional parameter.
-ro
Makes the working file read-only after this operation. Without this option, the file remains as it was prior to the operation. Usually, you use -ro to prevent yourself from editing a file that is not locked by you. -ro must be used with -l or-u or -nel. If you use -ro, you cannot use -rw.
-rw
Makes the working file read-write after this operation. Without this option, the file remains as it was prior to the operation. -rw must be used with -l or -u or -nel. If you use -rw, you cannot use -ro.
-d
A user specified Description. However, we continue to support -r as an alternate to -d for the description, but strictly for backward compatibility
-rf
Specifies the file name that contains the check-in reason. This is useful if the same reason should be applied to all check-ins across multiple command line runs.
-vl
Specifies a label (created using stcmd label) to be applied to the checked-in files. The label is enclosed in double quotation marks. This option can appear in the command more than once. The label can be either a view or revision label, but it must already exist in the application.
-active
The active process item.
-cr, -req, -task

Complete path from the project view's root folder to the change request, requirement, or task number to be used as a process item. Use the forward slash (/) as a delimiter between folder names.

For out-of-view process items, specify the project name and view name in front of the complete folder path. For example:

 -cr MyProject/RootView/RootFolder/SourceCode/37

This specifies change request 37 in the SourceCode folder (under the root folder) of the ChildView view in the MyProject project.

Note: For in-view process items, as long as the change request, requirement, or task numbers are the unique primary descriptors of their types (true by default), it is sufficient simply to specify the number, with no path. The project and view names are assumed from -p.

If a process item is specified, then the files being checked in are attached to the process item and follow the project process rules.

-cr, -req or -task are mutually exclusive. If any one of them is specified, -filter/-f are ignored.

-cp
Name of the code page used for localization and internationalization of the content, file and folder names, keyword expansion, etc. Supported code page names are US-ASCII (the default), UTF-8, UTF-16, windows-1252, ISO-8859-1, ISO-8859-9, ISO-8859-15, windows-31j, EUC-JP, Shift_JIS, ISO-2022-JP, x-mswin-936, GB18030, x-EUC-CN, GBK.
-mark
Indicates that, if all the files are successfully added, the process item’s status will be changed to fixed (for a change request), finished (for a task), or complete (for a requirement). The files are pinned to the revision with the new status. The item is not marked as fixed, finished, or complete unless all the files are successfully added.
-q
Enables quiet mode. The -q option is retained for backward compatibility with the old command line. If -q is specified, then -pf cannot be specified. The command will return no results.
-pf
Specifies the filter name whose associated filter properties produce the columns in the output matrix. Each command returns a result matrix. -pf determines the matrix columns. See -ofp for more information. If not specified, the primary descriptor property of the Type is returned as the command output. -pf does not apply to the select query command.
-ofp

Provides a file name with a fully qualified path into which to write the command output. By default, a "|" character separates each column in the output. A new line separates each row. The first row is the command name. The second row has the property names. All subsequent rows contain the data. If the file already exists, the output is appended to the end of the file.

It is possible to override the "|" character separator by specifying separator = fieldSeparator as a parameter to the connect command.

For example, separator = ;; specifies two adjacent semicolons ( ; ) as the column separator.

files...

Specifies the files to be used in the command by name or by file name-pattern specification, such as "*.c". All options are interpreted using the semantic conventions of UNIX instead of Windows because UNIX conventions are more specific. This means that "*", rather than "*.*" means “all files.” The pattern "*.*" means “all files with file name extensions.” For example, “star*.*” finds starteam.doc and starteam.cpp, but not starteam. To find all of these, you could use "star*".

Without this option, the default is "*". When used, this option must always be the last option. Any options after it are ignored.

If you use *, rather than "*" to indicate all files, a UNIX shell expands it into a series of items and passes this series as a group of options to the stcmd command. This can cause problems, for example, when you are checking out missing files, so it is best to use "*" to avoid unwanted complications.

If you use a set of file patterns, each pattern should be enclosed in its own set of quotation marks. For example, you can use "*.bat" "*.c", but you cannot use "*.bat *.c".

Note: Always enclose this option in quotation marks. Failure to do so can result in unpredictable consequences on all supported platforms.

Several special characters can be used in the file specification:

*
Matches any string including the empty string. For example, * matches any file name, with or without an extension. "xyz*" will match "xyz" and "xyz.cpp" and "xyzutyfj".
?
Matches any single character. For example, "a?c" will match "abc" but NOT "ac".
[...]
Matches any one of the characters enclosed by the left and right brackets.
-
A pair of characters separated by a hyphen (-) specifies a range of characters to be matched.

If the first character following the right bracket ( [ ) is an exclamation point (!) or a caret ( ^ ), the rest of the characters are not matched. Any character not enclosed in the brackets is matched. For example, "x[a-d]y" matches "xby" but not "xey". "x[!a-d]y" matches "xey" but not "xby".

A hyphen (-) or right bracket ( ] ) may be matched by including it as the first or last character in the bracketed set.

To use an asterisk (*), question mark (?), or left bracket ( [ ) in a pattern, you must precede it with the escape character (which is the backslash (\).

Example

The following example uses add to add all .doc files with the status Not In View to User Manual, a child of the root folder StarDraw (in the StarDraw view of the StarDraw project). It locks the files and gives them the description "First draft of chapter".

stcmd add -rp "1024/StarDraw/StarDraw/User Manual" -l -d "First draft of chapter" "*.doc"