Searching in Shortcut: Using Search Operators

You can also use the Navigational Search Bar from any page in Shortcut to find Stories using search operators. Also, as you type, our search will auto-suggest any operators that might match your query. Results can be found under the Stories tab in the Navigational Search Bar.

searchfrom_storiespage.png

Lastly, you can also use Power Bar to Search your Workspace. All Search operators are also supported within Power Bar. The results are the same when using Search operators between both the Search page, the always-available Search bar, and Power Bar.

Power_Bar_Search.png

In all those places, search results are listed in order of relevance (custom sorting isn't available at this time).

When a search query contains full-text search, relevance is based on how well the text matches the documents. When there isn't any text, and it's just operators, then the results are sorted by last modified date.

 

Story search queries will look for matches in Story titles, descriptions, and comments, and by default, all queries will use AND logic when combining multiple operators (OR logic is not available in Search at this time, but it is available when filtering on the Stories page).

There are two categories of search operators available when searching for Stories: Story-specific search operators (which will find results only for Stories), and general search operators (which will find results for both Stories and Epics).

 

Story-Specific Search Operators

type: Finds all Stories of a specific type (feature, bug, or chore). A query that contains more than one unique type operator will yield no results.
estimate: Finds all Stories of a specific point value. This is a numeric value, i.e. estimate:4. See our Estimate Scale article for more information about point estimations.
team: Finds all Stories associated with a specific Team. Enter the Team's mention name (without a leading @) directly following team:
has:attachment Finds all Stories with attachments. This operator only searches for attached files, not anything pasted or uploaded in comments

has:task

Finds all Stories with tasks

has:epic

Find all Stories added to an Epic

has:branch

Find all Stories that have a VCS branch associated

has:commit

Find all Stories that have a VCS commit associated

has:pr

Find all Stories that have a VCS pull request associated

branch:

Find all Stories that have a VCS branch with the given name associated

commit:

Find all Stories that have a VCS commit with the given full hash or url associated

pr:

Find all Stories that have a VCS pull request with the given number or url associated

is:blocked

Finds all Stories that have been marked using Story Relationships as blocked by another Story
is:blocker Finds all Stories that have been marked using Story Relationships as blocking another Story.
is:story

Returns only Stories in search results.

 

General Search Operators 

 

  • ID Number

    Finds a Story or Epic by its ID number.

    id:135

    Search by Story ID

    The following operators match text -- they can be single words that contain no spaces, or quoted strings that may contain spaces. 

  • Title

    This operator should allow full-text search on Story and Epic titles.

    It will be use-able in the Search page and the top Search UI, i.e:

    mceclip0.png

    • title:hello will search for hello in titles of stories and epics.
    • title:"hello world" will search for hello world in titles.
    • title:hello world will search for hello in titles  AND world in titles/descriptions/comments.
  • Description

    This operator should allow full-text search on Story and Epic descriptions.

    It will be use-able in the Search page and the top Search UI, i.e:

    mceclip1.png

    • description:hello will search for hello in description of stories and epics.
    • description:"hello world" will search for hello world in descriptions.
    • description:hello world will search for hello in descriptions  AND world in titles/descriptions/comments.
  • Comment

    This operator should allow full-text search on Story and Epic comments.

    It will be use-able in the Search page and the top Search UI, i.e:

    mceclip2.png

    • comment:hello will search for hello in comments of stories and epics.
    • comment:"hello world" will search for hello world in comments.
    • comment:hello world will search for hello in comments AND world in titles/descriptions/comments.

      Comment

      This operator should allow full-text search on Story and Epic comments.

      It will be use-able in the Search page and the top Search UI, i.e:

      mceclip2.png

      • comment:hello will search for hello in comments of stories and epics.
      • comment:"hello world" will search for hello world in comments.
      • comment:hello world will search for hello in comments AND world in titles/descriptions/comments.
  • Project

    Finds Stories in a specific Project (may use the Project name or Project ID). Or Epics with stories in a specific Project. For best results, queries for multi-word Project titles should be placed in double-quotes.

    project:frontend

    Find_Stories_by_Project_in_Clubhouse.png

  • Epic

    Finds all Stories in a specific Epic. For best results, queries looking for an exact match should be placed in double-quotes.

    epic:"all your epics are belong to us"

    Search by Epic

  • Milestone

    Find all Stories in the Epics within a specific Milestone. For best results, queries for multi-word Milestone titles should be placed in double-quotes.

    Search_for_Stories_in_a_Milestone_in_Clubhouse.png

  • Workflow State Operators

    Finds all Stories in a specific Workflow state. For best results, queries for multi-word workflow state titles should be placed in double-quotes.

    state:"ready for dev"

    Searching_for_Stories_by_Workflow_State.png

    The state: operator can be used with either a Workflow Name (as in the above example) or a Workflow State ID. 

    If you use the Workflow State ID, note that it is Workflow-specific, meaning it will return results only for Stories in a specific Workflow (even if the text-based State name, ex. Unscheduled, is the same across Workflows).

    In the example below, 500000016 is the Workflow State ID for the Unscheduled State in one Workflow in this Workspace. On the Stories page, you can select any Workflow State's additional options and then View State on Search Page.

    Screen_Shot_2020-01-29_at_10.21.21_AM.png

     

    If you use the Workflow Name with the operator, state:Unscheduled, it will search across Workflows based on the text of the name. You can see that in addition to the search results returned using 500000016, using the name Unscheduled returns results from all Workflows in the Workspace. 

    Searching across Workflow States

    In addition to the state: operator, the following operators search over the different types of workflow states.

    Since stories can only have one workflow state, using more than one of these operators can yield no results.

    • is:unstarted
    • is:started
    • is:done
  • Label

    Finds all Stories or Epics with a specific Story label. For best results, queries for multi-word labels should be placed in double-quotes.

    label:"user feedback"

    Search_for_Stories_by_Label_in_Clubhouse.png

    Note

    At this time, Stories do not inherit Epic labels. In this example, there are two Epics returned by this search because there is an Epic label also named 'user feedback.'

  • Owner

    Finds all Stories or Epics owned by a user. This query requires the user's full mention name (also known as their @-name) to work. Do not include the @ symbol at the beginning of the mention name.

    owner:stephlundberg

    Search by Owner

  • Requester

    Finds all Stories or Epics requested by a user. This query requires the user's full mention name (also known as their @-name) to work. Do not include the @ symbol at the beginning of the mention name.

    requester:stephlundberg
  • Inversions and Exclusions

    Of note, you can search for the inverse or exclude an operator by adding an ! or - in front of the operator. This is equivalent to a NOT boolean operator.

    For example, i.e. !has:comment and -has:comment will return Stories with no comments.

    Search for Stories without Comments

  • Dates and Date Ranges

    First, it's important to use the correct date formatting in your searches. The format Shortcut recognizes is 4 digit year-2 digit month-2 digit day:

    YYYY-MM-DD

    When searching for a date range, separate your dates with two periods:

    YYYY-MM-DD..YYYY-MM-DD

    You can make your date range open-ended (or unbounded, in search parlance) by adding an asterisk (*) on one side of the range. 

    An asterisk on the left side of the date range would find you all Stories before the specified date:

    *..YYYY-MM-DD

    And an asterisk on the right side of the date range would find you all Stories after the specified date: 

    YYYY-MM-DD..*

    You can also search using the terms yesterday and today, as well as tomorrow (but this latter term can only be used when searching for due dates, more on this below).

    Please note that numerical date values and date terms currently can't be mixed -- so a search for '2018-04-01..today' wouldn't work, for example.

    Date-Based Operators

    You can search for Stories that have been created, updated, completed, or moved using a specified date or date range, or the terms yesterday or today.

    You can also search for Stories that are (or were) due on a specified date or date range, or using the terms yesterday, today, or tomorrow.

    Examples:

    created:2018-05-22

    1.png 

    updated:today

     

    Note

    The updated operator will find Stories that have had changes or additions made to it on or within the specific time period (i.e., changes in description, comments, state, due date, Project, Epic, etc.).

    2.png

    Note

    When using the updated: operator, keep in mind that it asks "What Stories or Epics were last updated on/before/after this date or within this date range?"

    moved:*..2016-11-17

    Note

    The moved operator will only find Stories that have changed workflow state (i.e., those which have "moved" to a different workflow state column) on or within a specified time period.

    3.png

    completed:2018-04-01..2018-05-22

    4.png

    due:tomorrow

    5.png

  • The `has:` Operators

    • has:comment - Finds all Stories with comments.

    • has:label - Finds all Stories with a label.

    • has:deadline - Finds all Stories with a due date.

    • has:owner - Finds all Stories with an owner.

  • The `is` Operators

    • is:unestimated - Finds all Stories with a point value of 0 (in other words, Stories with no point estimation).

    • is:overdue - Finds all Stories with a due date in the past.

    • is:archived - Finds all archived Stories.

Updated

Was this article helpful?

1 out of 2 found this helpful

Have more questions? Submit a request