Command Reference
The format you use to enter a command is similar to the format used in a search query.
The syntax rules for using colons, curly 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 6.5',
you enter the following search query:
for: me tag: {YouTrack 6.5} #critical
. - To assign issues to yourself, associate them with the tag 'YouTrack 6.5' and elevate their priority to critical,
you enter the following command:
for me tag YouTrack 6.5 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 |
---|
clone | Clones the selected issue or issues. |
delete | Deletes the selected issue or issues. |
vote | Adds a vote to the selected issue or issues. |
unvote | Removes a vote from the selected issue or issues. |
Link Commands
You can use a command to add link types to one or more issues.
To add a link type with a command, select a link type and enter the issue ID of the target issue.
Command | Description |
---|
depends on | Adds a Depends on link to a target issue in the selected issue.
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 issue.
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 issue.
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 issue.
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 issue.
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 issue.
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 issue.
Also adds a Parent for link to the selected issue in the target issue. |
Tag Commands
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 issue or issues.
If the specified tag does not exist, a new tag is created and added to the selected issue or issues. |
untag | tag name | Removes the specified tag from the selected issue or issues. |
Star Commands
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 username for whom the action applies.
Command | Value | Description |
---|
star | username | Adds a star to the selected issue or issues for the user with the specified username. The user is added as a watcher for the issue. |
unstar | username | Removes a star from the selected issue or issues for the user with the specified username. The user is removed from the list of watchers for the issue. |
Custom Field Commands
You can use a command to set the value of any custom field in an issue.
To set the value for a field in a command, enter the field name followed by the new value.
Use the following commands to set the value for the Assignee of an issue:
Command | Description |
---|
me
my | Assigns the selected issue or issues to the current user. |
username | Assigns the selected issue or issues to the user with the specified username. |
for
assigned to | Assigns the selected issue or issues to the user with the specified username.
You can also assign issues to the current user with the command for me or assigned to me . |
unassigned | Clears the current value in the Assignee field. |
You can use the following commands to set the value for other custom fields.
You can either enter these commands in the format field
value
or enter the value directly.
The actual fields and values vary based on the custom fields that are used in your project.
The commands shown here are for default custom fields and values.
Command | Values | Description |
---|
state | submitted
open
in progress
reopened
resolved
unresolved
fixed
won't fix
can't reproduce
duplicate (see note below)
incomplete
obsolete
to be discussed
| Sets the value for the State field. |
type |
bug
task
feature
cosmetics
exception
meta issue
usability problem
performance problem
| Sets the value for the Type field. |
priority |
minor
normal
major
critical
show-stopper
| Sets the value for the Priority field. |
project | administrator-defined | Moves the selected issue or issues to the specified project. |
subsystem
in | administrator-defined | Sets the value for the Subsystem field |
<custom field> | administrator-defined | Sets the value for the specified custom field. |
affects
that affect
affecting | administrator-defined | Sets the value for the Affected versions field. |
fix for | administrator-defined | Sets the value for the Fix versions field. |
fixed in build | administrator-defined | Sets the value for the Fixed in build field. |
When you set the state to Duplicate,
you must also specify the ID of the issue that is duplicated by the current issue.
Agile Board Commands
You can 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.
To remove an issue from a sprint, enter the command remove Board <board name> <sprint name> . |
Last modified: 2 February 2017