Configure command
TFS 2018
Visual Studio 2019 | Visual Studio 2022
Enables an administrator to view and change the following configuration settings for a project in the Visual Studio Source Control Settings dialog box:
- Check-out Settings
- Check-in Policies
- Check-in Notes
Prerequisites
To use the configure command, you must have the Edit server-level information permission set to Allow. For more information, see Default TFVC permissions.
Syntax
tf configure [PathOfTeamProject] [/collection:TeamProjectCollectionUrl][/login:username,[password]]
Parameters
Argument
| Argument | Description |
|---|---|
<PathOfTeamProject> |
Path of the project whose configuration settings an administrator can view or change. |
<TeamProjectCollectionUrl> |
The URL of the project collection that contains the project that you specified, for example http://myserver:8080/tfs/DefaultCollection). |
<username> |
Provides a value to the /login option. You can specify a username value as either DOMAIN\username or username. |
Options
| Option | Description |
|---|---|
/collection |
Specifies the project collection. |
/login |
Specifies the user name and password to authenticate the user with Azure DevOps Server. |
Remarks
You can manage the following project settings by using the configure command:
Check-out Settings determine whether multiple users can edit files at the same time. You can also use them to configure the get latest on check-out behavior.
Check-in Policies provide controls that are invoked at check-in time, to make sure that defined criteria are met before a user checks in pending changes.
Check-in Notes define custom fields where users provide information during the check-in process. Check-in notes can be either required or optional.
For more information about these settings, see Walkthrough: Customizing Checkin Policies and Notes.
You configure the settings in the Visual Studio Source Control Settings dialog box, which appears after you run the tf configure command. When you complete your changes, select OK to save them.
For more information on how to use the tf command-line utility, see Use Team Foundation version control commands.
Note
Administrators can also access the Source Control Settings dialog box from the Visual Studio Team Explorer window. Select Settings, and then select Source Control under Team Project.
Examples
The following example displays the Source Control Settings dialog box, where you can examine and modify the project settings of the workspace for the c:\projects folder.
c:\projects>tf configure
The following example displays the myproj project settings in the project collection at http://myserver:8080/tfs/DefaultCollection.
c:\projects>tf configure $/myproj / http://myserver:8080/tfs/DefaultCollection