summaryrefslogtreecommitdiff
path: root/docs/search.markdown
blob: 4674a07e75427dff02a56f3bf5a444cf3b103474 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
Advanced Search Syntax
======================

Kanboard use a simple query language for advanced search.

Example of query
----------------

This example will returns all tasks assigned to me with a due date for tomorrow and a title that contains "my title":

```
assigne:me due:tomorrow my title
```

Search by task id or title
--------------------------

- Search by task id: `#123` or `123`
- Search by task title: anything that don't match any search attributes mentioned below

Search by status
----------------

Attribute: **status**

- Query to find open tasks: `status:open`
- Query to find closed tasks: `status:closed`

Search by assignee
------------------

Attribute: **assignee**

Query with the full name:

```
assignee:"Frederic Guillot"
```

Query with the username:

```
assignee:fguillot
```

Multiple assignee lookup:

```
assignee:user1 assignee:"John Doe"
```

Kanboard will search tasks assigned to the "user1" or "John Doe".

Query for unassigned tasks:

```
assignee:nobody
```

Query for my assigned tasks

```
assignee:me
```

Note: Results will also include subtasks assignee with the status todo or in progress.

Search by color
---------------

Attribute: **color**

Query to search by color id:

```
color:blue
```

Query to search by color name:

```
color:"Deep Orange"
```

Search by due date
------------------

Attribute: **due**

Query to search tasks due today:

```
due:today
```

Query to search tasks due tomorrow:

```
due:tomorrow
```

Query to search tasks due yesterday:

```
due:yesterday
```

Query to search tasks due with the exact date:

```
due:2015-06-29
```

The date must use the ISO8601 format: **YYYY-MM-DD**.

Operators supported:

- Greater than: **due:>2015-06-29**
- Lower than: **due:<2015-06-29**
- Greater than or equal: **due:>=2015-06-29**
- Lower than or equal: **due:<=2015-06-29**

Search by description
---------------------

Attribute: **description**

Example: `description:"text search"`

Search by external reference
----------------------------

The task reference is an external id of your task, by example a ticket number from another software.

- Find tasks with a reference: `ref:1234` or `reference:TICKET-1234`

Search by category
------------------

Attribute: **category**

- Find tasks with a specific category: `category:"Feature Request"`
- Find all tasks that have those categories: `category:"Bug" category:"Improvements"`
- Find tasks with no category assigned: `category:none`

Search by project
-----------------

Attribute: **project**

- Find tasks by project name: `project:"My project name"`
- Find tasks by project id: `project:23`
- Find tasks for several projects: `project:"My project A" project:"My project B"`

Search by column
----------------

Attribute: **column**

- Find tasks by column name: `column:"Work in progress"`
- Find tasks for several columns: `column:"Backlog" column:ready`

Search by swimlane
------------------

Attribute: **swimlane**

- Find tasks by swimlane: `swimlane:"Version 42"`
- Find tasks in the default swimlane: `swimlane:default`
- Find tasks into several swimlanes: `swimlane:"Version 1.2" swimlane:"Version 1.3"`