Skip to content

quick-start.md

Latest commit

 

History

History
148 lines (103 loc) · 2.47 KB

quick-start.md

File metadata and controls

148 lines (103 loc) · 2.47 KB
Raw
type tutorial
domain clear
audience practitioner
stability tactical
authority
provenance verifiability evidence currency
institutional
executable
moderate
undated
epistemic-layer practice

Quick Start

Get up and running with Task in 5 minutes.

Prerequisites

  • A terminal (macOS, Linux, or WSL on Windows)
  • Internet connection (for installation)

Step 1: Install Task

Download the binary for your platform:

# Linux x86_64
curl -L https://github.com/lauriliivamagi/task/releases/latest/download/task-linux-x86_64 -o task
chmod +x task
sudo mv task /usr/local/bin/

Verify the installation:

task --version

You should see output like task 1.x.x.

Step 2: Create Your First Task

task add "Learn Task"

Output:

Created task #1: Learn Task

Step 3: View Your Tasks

task list

Output:

ID   Title           Status   Priority   Due   Project
──────────────────────────────────────────────────────
1    Learn Task  todo     normal     -     -

Step 4: Add More Details

Create a task with a due date and project:

task add "Review documentation" --due tomorrow --project Learning

Create a task with tags:

task add "Try the TUI" --tag tutorial --tag quick-start

List your tasks again:

task list

Step 5: View Task Details

task view 1

This shows the full task with description, comments, subtasks, and metadata.

Step 6: Update a Task

Mark your first task as in-progress:

task update 1 --status in-progress

Step 7: Complete a Task

task update 1 --status done

Or use the shorter form:

task list  # Note the ID of the task you want to complete
task update 2 --status done

Step 8: Launch the TUI

For a more interactive experience:

task tui

Navigate with:

  • j/k or arrow keys to move
  • n to create a new task
  • x to toggle done
  • q to quit

What You've Accomplished

You can now:

  • Install Task
  • Create tasks with due dates, projects, and tags
  • List and filter tasks
  • View task details
  • Update task status
  • Use the terminal UI

Next Steps