Edit

Labels command (Team Foundation Version Control)

  • Article

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

Visual Studio 2019 | Visual Studio 2022

The Team Foundation Version Control (TFVC) tf labels command displays the list of labels in the TFVC server.

Prerequisites

To use the labels command, you must have the Read permission set to Allow for all files or folders to which the specified label is attached. If you have permission to some, but not all the files referenced in the label, partial results are displayed. For more information, see Default TFVC permissions.

Syntax

tf labels [/owner:ownername] [/format:(brief|detailed)] 
[/collection:TeamProjectCollectionUrl] [labelname] [/login:username,[password]]

Parameters

Arguments

Argument

Description

<ownername>

Provides a value such as DOMAIN\JuanGo or just juango to the /owner option.

<labelname>

Specifies a string that should be used to filter the list of labels. If this parameter is omitted, the label name field won't be filtered.

<TeamProjectCollectionUrl>

The URL of the project collection for which you want to display the list of labels, 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

/owner

Specifies the name of the user who owns the label. By default, the owner is the person who applies the label.

/format

Displays information about the specified label in one of the following formats:

  • Brief: Includes label, owner, and date created. This is the default.
  • Detailed: Also includes comments, scope, and a list of files and folders associated with each label.

/collection

Specifies the project collection.

/login

Specifies the user name and password to authenticate the user with Azure DevOps.

Remarks

  • The labels command displays information about labels in the TFVC server. If you don't specify a TFVC server, TFVC tries to determine the TFVC server by using the current directory. If the current directory isn't mapped to a TFVC server, you must specify one by using the /s option.

  • By default, the results display the label name, owner and creation date for each label. If the format is changed to detailed, comments and the list of files and folders associated with each label are also displayed.

  • For more information on how to use the tf command-line utility, see Use Team Foundation version control commands.

Examples

The following example displays the list of labels created by user jasonj.

c:\projects> tf labels /owner:jasonj

The following example displays information about the build1033 label and lists the files and folders to which the label has been applied in the TFVC server.

c:\projects> tf labels /format:detailed build1033

The following example displays all labels in the TFVC server that have a labelname that begins with build and are owned by the account executing the labels command.

c:\projects> tf labels build*