Tasks
Everything about tasks: the detail view, descriptions, labels, priorities, assignees, comments, checklists, and more.
Tasks are the core building blocks in Vikunja. Every to-do item, action item, or piece of work lives as a task inside a project.
Quick reference#
- Open a task: Click it in any view. In Gantt, double-click.
- Create a task: Use the input at the top of the list view or on the dashboard.
- Set details while typing: Use Quick Add Magic for dates, labels, priorities, and more.
- Save a web page as a task: Use the bookmarklet or your phone’s share menu.
- Move a task: Change its project in the detail view, or drag it to another project from list and Kanban views.
- Delete a task: Click Delete in the detail view. It goes to the trash for 30 days.
Opening a task#
Click any task in the list, Kanban, or table view to open the task detail view. In the Gantt view, double-click the task instead.
The detail view is where you edit the task title, description, dates, labels, assignees, attachments, and everything else.
Title#
The task title is displayed at the top of the detail view. Click on it to edit it inline.
Description#
Below the title is the description editor. If the task does not have a description yet, the editor opens in edit mode so you can start typing immediately.
The editor supports standard rich-text formatting such as headings, bold, italic, and lists. Markdown shortcuts also work, and pasted Markdown is converted automatically.
You can upload attachments directly in the editor by dragging in a file or using the upload button.
Right sidebar#
The right sidebar holds the task properties and actions.
Marking a task as done#
Click the Done button at the top of the right sidebar to mark the task as completed. Click it again to reopen the task.
Subscribing to a task#
Click Subscribe to follow changes on the task. Subscribers receive notifications for comments, edits, and triggered reminders.
You are subscribed automatically when you create a task, when you are assigned to one, and when you are subscribed to the project the task belongs to (or one of its parent projects). Tasks created through a link share have no user to subscribe, so nobody is subscribed automatically in that case.
If your subscription comes from the project rather than the task itself, you can still unsubscribe from that one task. Click Unsubscribe on it and you keep the project subscription for everything else.
Favoriting a task#
Click Favorite to add the task to the Favorites project in the sidebar. This is useful for tasks you need to return to often.
Duplicating a task#
Click Duplicate in the right sidebar to create a copy of the task. The copy includes the title, description, due, start, and end dates, repeat settings, priority, progress, color, assignees, reminders, labels, attachments, and the cover image. Vikunja also links the copy to the original with a “copied from” relation.
Comments and relations to other tasks are not copied.
The copy is created in the same project as the original. You can move it to another project afterwards.
Deleting a task#
Click Delete at the bottom of the right sidebar, or press Delete (Backspace on a Mac). The task moves to the trash right away, without a confirmation dialog. Click Undo in the message that appears to bring it back.
Deleted tasks stay in the trash for 30 days. You can restore them from there until then. See Trash for details.
Labels#
Labels help you categorize tasks and build filters later.
Click the labels field in the right sidebar to search for and add existing labels, or create new ones on the fly.
See Labels for more details on creating and managing labels.
Priority#
Set a priority from Unset to Do Now.
You can also use priority in filters.
Progress#
Set a percentage between 0 and 100 to track progress manually.
Color#
Assign a color to make the task stand out, especially in Kanban and Gantt views.
Assignees#
Assign one or more users who are responsible for completing the task.
Only users who already have access to the project can be assigned to a task. See Sharing & Teams for how to give users access.
Dates#
A task can have a start date, end date, and due date. See Dates & Reminders for details.
Attachments#
Click Attachments in the sidebar (or press f) to open the file picker and upload files. You can also drag files into the description editor.
Clicking an uploaded attachment opens a preview where possible:
- Images (
jpg,jpeg,png,gif,bmp) open in a preview where you can zoom and pan, with the mouse or the keyboard. From Vikunja 2.6.0 onwards. - PDFs open inline in a modal using your browser’s built-in PDF viewer, so you can scroll, zoom, and search without leaving the task. PDF previews are available from Vikunja 2.3.0 onwards.
- Videos open in a modal and play there, as long as your browser supports the format. Video attachments show a play icon in the attachment list. From Vikunja 2.6.0 onwards.
- Audio plays directly in the attachment row. Click another audio attachment and the first one stops. From Vikunja 2.6.0 onwards.
- Other file types download directly.
Each attachment row shows the file name. File size, type, and who uploaded it are in a tooltip on the row.
A separate download button next to each attachment always downloads the file, regardless of whether it has a preview.
Relations#
Use relations to link tasks together, for example as subtasks, parent tasks, blockers, or related work.
Click Add a relation, find the other task, then choose the relation type.
See Task Relations for the full list of available relation types and how to use them.
Moving a task#
You can move a task to another project in two ways:
- From the detail view: Use the project field in the right sidebar to select a different project.
- From the list or Kanban view: Drag the task onto another project in the sidebar.
Changing the Kanban bucket#
If the task’s project has a manual Kanban view, the detail view shows a small bucket picker next to the project name, just below the task title. Click it to move the task to a different bucket without leaving the detail view.
Changing the bucket this way has the same effect as dragging the task on the Kanban board: moving it into the done bucket marks the task as done, and moving it back out marks it as not done.
The picker only appears for projects that have a regular Kanban view with manually managed buckets. Projects that use filter-based buckets do not show the picker because bucket membership is controlled by filters there.
Comments#
Comments are shown below the task description and use the same editor.
You can mention other users by typing @ followed by their username. Mentioned users will receive a notification.
You can switch comment order between oldest-first and newest-first once the task has comments.
Checklists#
Use the checkbox list option in the description editor to create a checklist.
Checklist progress appears on the task card in the list view, so you can see completion at a glance.
Quick Add Magic#
You can set dates, labels, priorities, assignees, and more while typing a task title. See Quick Add Magic for the full syntax.
Hover preview#
In the list view, hovering over a task opens a small preview with the title, description, creator, labels, and other key details.
Saving a web page as a task#
Available since Vikunja 2.8.0.
You can add a browser bookmark that turns the page you’re reading into a task. Create a new bookmark, name it something like “Add to Vikunja”, and paste this as its URL. Replace https://vikunja.example.com with the address of your Vikunja instance, including the subdirectory if you host Vikunja under one.
javascript:(()=>{const u=new URL('https://vikunja.example.com/');u.searchParams.set('title',document.title);u.searchParams.set('url',location.href);u.searchParams.set('description',String(getSelection()));window.open(u,'vikunja','width=700,height=500')})()
Click the bookmark on any page. Vikunja opens in a small window with a new task filled in:
- The page title becomes the task title. It’s wrapped in quotes so Quick Add Magic doesn’t turn words like “tomorrow” into a due date. The quotes are stripped when you create the task. Remove them if you want quick add magic to work.
- A link to the page goes into the description, followed by any text you had selected.
The link and the selected text show up below the title. Click the × next to them to leave them out. Press Enter to save the task in your default project.
From your phone#
On Android, install Vikunja from your browser’s menu to your home screen. Vikunja then shows up in the share menu, and sharing a page fills in a new task the same way the browser bookmark does.
Building your own links#
The bookmarklet opens the Vikunja home page with these query parameters. Any one of them is enough to open the new task dialog:
| Parameter | Used for |
|---|---|
title | Task title |
url | Link added at the top of the description |
description | Plain text added to the description, below the link |
For example, https://vikunja.example.com/?title=Call%20the%20dentist opens the new task dialog with that title. The task is only created once you press Enter.