Command Reference
Commands are basically a series of attribute and value pairs that apply changes to one or more issues at once. In many cases, you can skip the attribute and enter the value that you want to apply. YouTrack detects which attributes use the specified value and suggests valid options for the command.
The format you use to enter a command is similar to the syntax used in a search query. However, the rules for using colons, braces, and number signs do not apply to commands. For example:
To search for critical issues that are assigned to you and associated with the tag YouTrack 2017, you enter the following search query:
for: me tag: {YouTrack 2017} #critical.To apply a command that assigns the issues to yourself, adds the tag YouTrack 2017, and elevates the priority to critical, you enter the following command:
for me tag YouTrack 2017 critical.
Simple Commands
The following commands do not require any additional attributes or values. Simply select one or more issues and apply the command.
Command | Description |
|---|---|
comment | Adds a comment to the selected issues. Enter the comment text itself in the Comment input field. You can also select a group in the Visible for Group drop-down list to set the visibility of the comment. |
delete | Deletes the selected issues. |
clone | Creates a clone of the selected issues. You can also apply this action with the |
The following commands update specific issue attributes by adding or removing a specified value. You can either specify the attribute and value or simply enter the single value.
Command | Description |
|---|---|
add | Adds the specified value to the attribute. Use this command to add values to custom fields that store multiple values instead of changing the existing value. Additional usages of this command are described for each attribute that supports it. |
remove | Removes the specified value from the attribute. Use this command to remove single values from custom fields that store multiple values. Additional usages of this command are described for each attribute that supports it. |
Projects
Use the following commands to move issues to another project.
Command | Value | Description |
|---|---|---|
| project name | Moves the selected issues to the specified project. |
You can also enter the <project name> as a single value.
Custom Fields
You can use commands to set or change the values in custom fields. Additional options for the Assignee field are described in the Assignee section. The following options are supported for custom fields:
Enter commands in the format
field namevalue.Enter the
valueas a single value. The corresponding fields that use this value are shown in the auto-completion dialog.To update the value of a custom field that is managed by a state-machine rule in a workflow, enter the command in the format
field nameevent.If the custom field can contain an empty value, enter the name of the empty value to clear the field.
For custom fields that store multiple values, you can reference this attribute with add and remove commands:
Command | Description |
|---|---|
add <field name> <value> | Adds the specified single value to the specified custom field. Unspecified values that are currently stored in the field are not affected. |
remove <field name> <value> | Removes the specified single value from the specified custom field. Unspecified values that are currently stored in the field are not affected. |
If you have the Update Project permission, you can add values to the custom field. This option is displayed in the Command Preview section of the dialog.
The actual fields and values vary based on the custom fields that are used in your project. All custom fields support the field value command syntax. Other commands in this list use the aliases that are assigned to default custom fields.
Command | Value | Description |
|---|---|---|
<custom field> | value name | Changes the value for the specified custom field.
The only command that requires additional parameters is |
| login | Sets the value for the Assignee field for the selected issues to the specified user. You can also assign issues to the current user with the command For additional options, see Assignee. |
in | value name | Changes the value for the Subsystem field. |
| version | Changes the value for the Affected versions field. |
| version | Changes the value for the Fix versions field. |
fixed in build | build | Changes the value for the Fixed in build field. |
Assignee
Assignee differs from other custom field types because it stores a user type. There are several aliases that you can use to set the value of this field.
The aliases
meandmyreference the login of the current user. You can enter these aliases as single values to assign the selected issues to the current user.You can enter a user
loginas a single value to assign the selected issues to a specific user.Use the name of the empty value (
Unassigned) to clear the field.Use the syntax
add <login>to assign an issue andremove <login>to unassign an issue.
You can also set the value of this field with the following commands:
Command | Value | Description |
|---|---|---|
| login | Sets the value for the Assignee field for the selected issues to the specified user. You can also assign issues to the current user with the command |
Work Items
Use the work to add work items to one or more issues. Specify values for the work item in the following order: <work item type> <date> <time period> <description> Use the following parameters to set values for the work item:
Parameter | Condition | Description |
|---|---|---|
work item type | Optional | Set the work item type. |
date | Optional | Set the date with the format |
time period | Mandatory | Enter the amount of time spent working on the issue. |
description | Optional | Enter a description of the work performed. |
You can also use the syntax add work <work item> The remove command is not supported.
Link Types
You can use a command to add link types to one or more issues. To add a link type with a command, enter a link type and enter the issue ID of the target issue. You can also reference this attribute with add and remove commands:
Command | Description |
|---|---|
add <link type> <issue ID> | Adds the specified link type to the specified issue. |
remove <link type> <issue ID> | Removes the specified link type from the specified issue. |
The following commands correspond to the outward names and inward names for default issue link types in YouTrack. Custom link types also use the outward names and inward names as commands.
Command | Description |
|---|---|
depends on | Adds a Depends on link to a target issue in the selected issues. Also adds an Is required for link to the selected issue in the target issue. |
duplicates | Adds a Duplicates link to a target issue in the selected issues. Also adds an Is duplicated by link to the selected issue in the target issue. |
is duplicated by | Adds an Is duplicated by link to a target issue in the selected issues. Also adds a Duplicates link to the selected issue in the target issue. |
is required for | Adds an Is required for link to a target issue in the selected issues. Also adds a Depends on link to the selected issue in the target issue. |
parent for | Adds a Parent for link to a target issue in the selected issues. Also adds a Subtask of link to the selected issue in the target issue. |
relates to | Adds a Relates to link to a target issue in the selected issues. Also adds a Relates to link to the selected issue in the target issue. |
subtask of | Adds a Subtask of link to a target issue in the selected issues. Also adds a Parent for link to the selected issue in the target issue. |
Tags
You can use a command to add tags to an issue. You can also remove existing tags from an issue.
Command | Value | Description |
|---|---|---|
tag | tag name | Adds the specified tag to the selected issues. If the specified tag does not exist, a new tag is created and added to the selected issues. You can also use the syntax |
untag | tag name | Removes the specified tag from the selected issues. You can also use the syntax |
Visibility
You can set or change the visibility setting for an issue with a command.
Command | Value | Description |
|---|---|---|
visible to | group login | Sets the issue visibility to the specified user or group. |
You can also reference this attribute with add and remove commands:
Command | Description |
|---|---|
add visible to | Adds the specified user or group to the list of users and groups for whom the issue is visible. |
remove visible to | Removes the specified user or group from the list of users and groups for whom the issue is visible. |
Voters
The following commands manage votes for issues on behalf of the current user.
Command | Description |
|---|---|
| Adds a vote to the selected issues. |
unvote | Removes a vote from the selected issues. |
Watchers
You can use a command to star or unstar an issue. To star and unstar issues with a command, enter the command and enter the login for whom the action applies.
Command | Value | Description |
|---|---|---|
| login | Adds the Star tag to the selected issues on behalf of the user with the specified login. This action adds the user to the list of watchers. You can also use the syntax |
unstar | login | Removes the Star tag from the selected issues for the user with the specified login. This action removes the user from the list of watchers who subscribe to updates for issues with the Star tag. However, the user may remain on the list of watchers for other reasons. |
note
Auto-completion Suggestions for User AccountsThese commands display user logins in the auto-completion list. The suggestions are filtered to show only users who have the Read Issue permission for the issue or issues to which the command will be applied.
Boards
Use the following command to assign an issue to a sprint on an agile board.
Command | Value | Description |
|---|---|---|
Board <board name> | sprint name | Assigns the issue to the sprint with the specified name on the specified agile board. You can substitute the sprint name with For agile boards that use the Add new issues to sprint option, you can use |
You can also reference this attribute with add and remove commands:
Command | Description |
|---|---|
add Board <board name> <sprint name> | Adds selected issues to the specified sprint for the specified agile board. |
add Board <board name> | Adds selected issues to the specified agile board. If sprints are enabled for the board, the issues are added to the current sprint. |
remove Board <board name> <sprint name> | Removes selected issues from the specified sprint for the specified agile board. |
remove <board name> | Removes selected issues from any sprint for the specified agile board. For some board configurations, this command is handled differently.
|