Source control command line reference

Command syntax

The reference page for each scm subcommand provides a synopsis of command syntax using the following conventions. Options that have alternate forms are delimited by brackets. For example:

Commands take the general form:

Quoting and other shell conventions

When arguments to scm subcommand options contain spaces, they must be quoted. Shell wildcards are permitted where applicable (specifying files to check in, for example).

Creating and storing login credentials

While many of the scm subcommands have options that support a one-time connection to a repository, it is generally more convenient to use the scm login command to store a repository URI and credentials, which can then be used by other scm commands. Credentials stored in this manner are difficult, but not impossible, to discover. You can remove stored credentials with the scm logout command.

Sandboxes and scm subcommands

The scm load and scm share commands create a sandbox for use by Engineering Workflow Management source control command line tools. You can run Engineering Workflow Management source control command line tools in a sandbox or specify it using the -d option, which is common to all scm subcommands that require a sandbox context. If you are running the subcommand in a sandbox, you do not need to specify -d.

These subcommands do not allow you to specify a repository URI on the command line. Instead, they derive it from metadata associated with the sandbox in which you are running the command (or which you have specified using -d). If you have used scm login to store credentials for this repository, the subcommand does not prompt for them.

Do not use Engineering Workflow Management source control command line tools to work in an Eclipse workspace.

UUIDs and aliases

Many scm subcommands take an argument that refers to a repository object. These references can take the form of a name (such as the name of a sandbox), a UUID ( a unique identifier assigned to each repository object), or an alias. Aliases are short strings of digits that you can use to refer to repository objects wherever such references are accepted by an scm subcommand. The scm command automatically creates these aliases whenever you run a subcommand that returns the name or UUID of a repository object. To use them, you must type the entire alias (they are not integers, so you must include leading zeroes when they are present). Aliases are unique to a sandbox. You cannot share them with other team members. You cannot list them. They are not persistent over long spans of time (any alias can be re-used to refer to another object after the set of unused aliases has been exhausted).

You can also show/hide aliases and UUIDs by passing -a yes/no and -u yes/no to scm. For example, scm -a y -u y list ws ... shows the alias/UUID of all sandboxes. Substituting -a n shows just the UUIDs, and -a n -y n shows neither.

Examples presented in scm subcommand reference pages display and use aliases where appropriate.

Status flags