List repository objects
Purpose
The scm list subcommand
lists objects, including project areas, team areas, streams, workspaces,
files, and contributors (users) in the specified repository. The alias
for scm list is scm ls.
Synopsis
- To run scm list after you have used scm
login to create stored credentials:
scm list [ -r
| --repository-uri ] repository URI or nickname { [ -c | --contrib ] name [ -v | --verbose ] --depth levels} object type {object-type specific options}
- To run scm list supplying credentials
on the command line:
scm list [ -r | --repository-uri ] repository URI [ -u | --username ] user ID in repository [ -P | --password ] password for user ID in repository { [ -c | --contrib ] name [ -v | --verbose ] --depth levels } object type {object-type specific options}
Options and arguments
- [ -c | --contrib ] name
- A user ID valid in the specified repository. If this option is
supplied, the list of item types is limited to
items owned by the specified contributor. If this option is omitted, name defaults
to the user ID of the user running scm list.
Not applicable when listing project areas, contributors, components,
and remote files.
- --depth levels
- When listing remote files, levels specifies
the maximum depth of recursion. If not specified, levels defaults
to 3, listing the first three levels of folder contents in the specified
component. Specifying levels as – lists all remote
files in the specified component. Not applicable for other object
types.
- [ -P | --password ] password for user ID in repository
- The password for the specified user ID in
the named repository. If this option is not included on the command
line, you are prompted for a password. If you specified a repository
URI or nickname for which you have stored credentials using the scm
login command, this option is ignored.
- [ -r | --repository-uri ] repository URI
- Specifies the repository in which to take
this action. If you have stored repository credentials using the scm
login command, you can use the nickname you supplied for
these stored credentials
- [ -u | --username ] user ID in repository
- Specifies a user ID that exists in the named
repository. If you specified a repository URI or nickname for which
you have stored credentials using the scm login command,
this option is ignored.
- [ -v | --verbose ]
- Provide additional informational messages
while operating. When listing components,
show baselines too.
- object type
- The type of item to list. One of:
- components
- List all components to which the specified contributor has access.
- contributors
- Lists the user IDs of all contributors who have accounts in the
specified repository.
- project-areas
- List all project areas in the repository.
- streams
- List streams in all team areas of which the specified contributor
is a member.
- remotefiles
- List remote files in a workspace, component, or project. Object-type
specific options for this object type are:
- workspace component
- The name of a workspace and a component in that workspace. Separate
the names with a space. The named component must
exist in the named workspace.
- remotePath
- A Path name within the specified component.
This option is optional. Use it to constrain the list of remote paths
listed for a component.
- team-areas
- List all team areas of which the specified contributor is a member.
- workspaces
- List all workspaces owned by the specified contributor.
Examples
List workspaces owned by the user
associated with stored credentials for the repository nicknamed jazzhost:
C:\>scm list workspaces -r jazzhost
(1000) "Community Site Workspace"
(1101) "HelloJazz"
(1068) "UA-CLI"
(1113) "HelloJazz2"
(1109) "REST-svc-dev"
(1141) "Rob's test workspace"
List workspaces
owned by user brc in the repository nicknamed jazzhost:
C:\>scm list workspaces -c brc -r jazzhost
(1141) "Rob's test workspace"
(1109) "REST-svc-dev"