CONFIGURECLIENT

Description

Configures the Unity VCS client for the current machine user to work with a default server.

Usage

cm configure [--language=<language> --workingmode=<mode> [AuthParameters] --server=<server> [--port=<port>]] [--clientconf=<clientconfpath>]

Options

Option / ArgumentDescription
--languageAvailable languages. See remarks for more info.
--workingmodeAvailable users/security working modes. See remarks for more info.
--serverUnity VCS server IP / address.
--portUnity VCS server port (optional for Cloud servers).
--clientconfFile path used to create the configuration file (optional).
AuthParametersAuthentication parameters. See Remarks for more info.

Help

Remarks

The cm configure command cannot be used on Cloud Edition or DVCS Edition of Unity VCS. Use 'plastic --configure' instead.

Languages

  • en (English)
  • es (Spanish)

Working modes

  • NameWorkingMode (Name)
  • NameIDWorkingMode (Name + ID)
  • LDAPWorkingMode (LDAP)
  • ADWorkingMode (Active Directory)
  • UPWorkingMode (User and password)
  • SSOWorkingMode (Single Sign On)

Client configuration

If this parameter is not specified, the default directory for 'client.conf' file would be '%LocalAppData%\plastic4' on Windows or '$HOME/.plastic4' on linux/macOS.

AuthParameters

  • LDAPWorkingMode and UPWorkingMode
    • --user=<user>
    • --password=<password>
  • SSOWorkingMode
    • --user=<user>
    • --token=<token>

Examples

cm configure

(runs the interactive Unity VCS client configuration command)

cm configure --language=en --workingmode=LDAPWorkingMode --user=jack --password=01234 --server=plastic.mymachine.com --port=8084

(configures the Unity VCS client with the specified parameters and creates the 'client.conf' configuration file in the default directory)

cm configure --language=en --workingmode=NameWorkingMode --server=plastic.mymachine.com --port=8084 --clientconf=clientconf_exp.conf

(configures the Unity VCS client with the specified parameters and creates the 'client.conf' configuration file in the specified path)

cm configure --clientconf=c:/path/to/myclient.conf

(Specified path will be used to create the client configuration file)

cm configure --clientconf=myclient.conf

(File myclient.conf inside default config directory will be used)

cm configure --clientconf=c:/exisitingDirectory

(Default filename, client.conf, in specified directory will be used) configuration file in the specified path)