Add Folder: add-folder

Use add-folder to add StarTeam folders to a view from the command line. You can add the folder to the root folder or any other folder in that view. The working folder for your new StarTeam folder is created by default within StarTeam, not on your workstation. The working folder has the same name as the StarTeam folder. It is a child folder of the working folder for the StarTeam folder’s parent.

For example, suppose you create a StarTeam folder named Wizard. Wizard is a child of a StarTeam folder whose working folder is C:\StarDraw. Therefore, Wizard’s working folder becomes C:\StarDraw\Wizard.

Using the -is option allows you to add a branch of folders to the project view’s folder hierarchy. When you use -is, use either -rp or -fp to specify the folder on your workstation whose child folders will become the new StarTeam folder’s child folders. Using -fp is recommended, as it specifies the path directly to the parent of those child folders. In contrast, -rp, which specifies the path to the working folder used for the view's root folder, appends StarTeam folder names in the hierarchy from the root folder to the new folder to the path you specify. Only when you use the -is option do -rp and -fp have any effect on this command.

Syntax

The syntax for this command is:

stcmd{Ex} add-folder [[-p "projectSpecifier"] [-epwdfile "filePath"] 
[-cmp] [-csf] [-encrypt encryptionType] ][-is] [-rp "folderPath" | 
-fp "folderPath"] -name "folderName" [-d | -r "description"| -rf "fileName"]
[-ex "excludeType"] [-q|-pf "filterName"] [-ofp "resultsOutputFilePath"] 
[-exlist "fileMask" | -exfile "fileName"]
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.

-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.

-name
Specifies the name. Maximum of 254 characters.
-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.
-ex

Indicates the exclude lists to be used by this new folder. Exclude lists exclude certain files or types of files from visibility. If a working file in this folder’s working folder would have the status Not In View but it matches a file specification in one of the exclude lists, the application does not display it at all. It is as though the file did not exist.

For example, suppose you are creating files in an application that makes automatic backup copies of each file (with the extension .bak) every time you save a file. Your working folder might contain several .bak files, but you have no reason to add them to the project view. From the application, it is annoying to see these .bak files as possible candidates, so you exclude them. Excluding files is done on a per-folder basis. However, exclude lists can be inherited from parent folders.

The full syntax is: -ex excludeType

The types include:

inherit
This folder will inherit any exclude lists used by its parent folder and use the exclude list specified with either -exfile or -exlist (if one is created). This is the default.
local
This folder will use only the exclude list specified with either-exfile or -exlist.
none
This folder will use no exclude lists, regardless of what you specify with either -exfile or -exlist.
-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.

-exlist

Specifies the local exclude list for this folder. Use a maximum of 254 characters. Enter one or more file specifications (using the standard * and ? wild cards), separated by commas, spaces, or semicolons. To include a comma, space, or semicolon as part of the specification, enclose the specification in double quotation marks: *.exe,*.dll p*z.doc;*.t?t "test *.*"

If you are using double-quotation marks in your exclude list or have a lengthy exclude list, we recommend that you use the -exfile option. With -exlist, each quotation mark in the exclude list needs to be preceded by the escape character for your system or shell. For example, the caret (^) works on NT systems. With-exfile , you do not need to use escape characters.

-exfile
Specifies the path to the file that contains the local exclude list for this folder. See -exlist for a description of the exclude list’s contents.

Example

The following example uses add-folder to create a folder named Wizard as a child of the StarDraw folder, the root folder of the StarDraw project view. In addition, it sets a local exclude list for Wizard. By default, Wizard inherits its parent folder’s exclude lists and use the local one as well.

Use the set command to set the context of the project/view/parent folder.

stcmd add-folder -name "Wizard" -d "StarDraw setup wizard" -exlist "*.bak"

The next example creates the same folder as in the previous example. However, it includes child folders. In this case, the folder with the path C:\Wizard has child folders (Source, Spec, and Doc), all of which are added as StarTeam folders in addition to Wizard. All of the new folders (Wizard, Source, Spec, and Doc) will have the default working folders assigned to them automatically by the StarTeam Server, regardless of the setting for -fp. Wizard will be the parent of Source, Spec, and Doc. StarDraw is the parent of Wizard.

stcmd add-folder -name "Wizard" -d "StarDraw setup wizard" -is -fp "C:\Wizard" exlist "*.bak"