Command-line Global Options Reference

Applies to Collaborator 14.7, last modified on December 18, 2024

Description

The following topic lists the available command-line global options.

Global Options can be specified on the command-line, or they can be saved and applied to every command using the ccollab set command.

Global options specified explicitly for a particular command-line call override the values saved by the ccollab set command.

General Options

Option

Description

--debug

Run in debug mode, create a log file at the following location: ~/.smartbear/log/ccollab.log on Unix platforms and %USERPROFILE%/.smartbear/log/ccollab.log on Windows platforms.

--editor <value>

External editor to use for editing file list.

--editor-prompt

Prompt user for input to signal editing of file list complete.

--no-browser

Do not pop up a web browser when the command completes.

--non-interactive

Do not interact with user.

--overwrite-trust-store-in-ssl

Overrides the java.net.ssl.truststore VM option with hard coded default values ($JAVA_HOME\lib\security\cacerts).

Restart client to apply this option.

--password <value>

Password or login ticket to use when connecting to the Collaborator server.

When single sign-on authentication is disabled, specify password. When single sign-on authentication is enabled, specify login ticket instead.

--pref-dir <value>

Overrides the location of Collaborator configuration files.

The path to preference folder must be specified either as relative path (a subfolder of the SmartBear profile folder), or as absolute path.

The folder should allow read/write access to files.

--quiet

Do not display progress messages.

--scm <value>

Manually sets the SCM system type, for example, "perforce" or "none" for no SCM System. Clearing this option causes the SCM system to be auto-detected.

--server-proxy-host <value>

Proxy server URL to use to connect to the Collaborator server.

--server-proxy-port <value>

Proxy server port number to use to connect to the Collaborator server.

--url <value>

URL to use when connecting to the Collaborator server.

--user <value>

Username to use when connecting to the Collaborator server.

AccuRev-specific Options

Option

Description

--accurev-depot <value>

AccuRev depot name.

--accurev-exe <value>

Full path to the "accurev" command-line client.

--accurev-anc-algorithm <value>

Which algorithm to use when calculating the predecessor, either predecessor, previous-occupant, or basis-version.

ClearCase-specific Options

Option

Description

--ccrc-server-url <value>

CCRC server URL (for ClearCase Remote Client integration only).

--ccrc-user <value>

CCRC username (for ClearCase Remote Client integration only).

--ccrc-passwd <value>

CCRC password (for ClearCase Remote Client integration only).

--clearcase-exe <value>

Full path to the "cleartool" command-line client.

--clearcase-update-snapshot

Whether to update ClearCase snapshot views prior to uploading files for review.

CVS-specific Options

Option

Description

--cvs-exe <value>

Full path to the "cvs" command-line client.

--cvsroot <value>

Connection to the CVS repository.

Git-specific Options

Option

Description

--git-exe <value>

Full path to the "git" command line client.

--git-skip-index

Defines whether the changes you upload via the ccollab addchanges command should be taken from the working tree (including not-yet-committed changes) instead of from the index. This is an analogue of the git commit -a command.

Mercurial-specific Options

Option

Description

--mercurial-exe <value>

Full path to the "mercurial (hg)" command line client.

Perforce-specific Options

Option

Description

--p4 <value>

Full path to the P4 executable.

--p4port <value>

How to connect to the Perforce server.

--p4user <value>

Perforce user name.

--p4passwd <value>

Perforce password or ticket.

--p4client <value>

Mapping of Perforce server data to the local machine.

--p4-ignore-integration-history <value>

Ignore integration history when calculating predecessor.

--p4charset <value>

Perforce character set used for translation of Unicode files.

--p4-require-empty-default-changelist

If true, do not allow uploads if the default changelist contains files.

--p4-specify-command-charset <value>

Should a character set be specified for communication with Perforce.

PTC Integrity-Specific Options

Option

Description

--mks-host <value>

PTC Integrity server name.

--mks-port <value>

PTC Integrity server port.

--mks-user <value>

PTC Integrity user name.

--mks-passwd <value>

PTC Integrity user password.

--mks-expand-keywords

Specifies whether to expand keywords in source files.

The arguments use the --mks prefix as MKS Integrity is a former name of PTC Integrity.

Rational Synergy-specific Options

Option

Description

--ccm-exe <value>

Full path to the "ccm" command-line executable.

--ccm-user <value>

User Name to use when starting a Rational Synergy session.

--ccm-passwd <value>

Password to use when starting a Rational Synergy session.

--ccm-engine-host <value>

Host the Rational Synergy Engine will run on.

--ccm-database-path <value>

Path of the Rational Synergy database to connect with.

--ccm-local-database-path <value>

Path of the local Rational Synergy database, typically c:/temp/ccm or /tmp/ccm.

--ccm-remote-client

Start Rational Synergy sessions as a Remote Client.

--ccm-server-url <value>

Server URL for Web-Mode Rational Synergy servers.

Rational Team Concert-specific Options

In order to use Rational Team Concert integration from command-line client, you need to configure both Collaborator server and clients and RTC server. See configuration instructions.

Option

Description

--rtc-repository-uri <value>

The URI of the repository to work with.

--rtc-username <value>

The user name to use for the chosen RTC repository.

--rtc-password <value>

The password of the user.

Subversion-specific Options

Option

Description

--svn-exe <value>

Full path to the "svn" command-line executable.

--svn-look-exe <value>

Full path to the "svnlook" command-line executable (used by Subversion triggers).

--svn-repo-url <value>

Subversion repository URL.

--svn-user <value>

Subversion user name.

--svn-passwd <value>

Subversion password.

--svn-require-client-certificate-password <value>

Use this if you have a non-empty and unsaved password for your SSL Client Certificate.

--svn-auto-add

Treat unversioned files as if they had been added to Subversion.

--svn-recurse-externals

Recurse in the "svn:externals" directories as if they were part of the same repository.

--svn-repo-path <value>

Full path to the repository (used by Subversion Triggers).

Team Foundation Server-specific Options

Option

Description

--tfs-collection <value>

For self-hosted version of Team Foundation Server, specify the URL of Team Foundation Project Collection to work with.

For SaaS version of Team Foundation Server, specify the URL of your Visual Studio Team Services account (without project or collection names).

--tfs-user <value>

The name of Team Foundation user.

--tfs-passwd <value>

The personal access token of the user. For detailed information on generating a personal access token, follow Microsoft documentation.

See Also

Command-Line Client
ccollab

Highlight search results