Quick Start

This guide will help you get started with QuickUp! in just a few minutes.

Installation

Install QuickUp! using pip:

pip install quickup

Authentication

Log in with ClickUp via your browser:

quickup login

This opens ClickUp in your browser. After approving access, your credentials are saved automatically — no manual token setup needed.

For CI or automation environments, you can instead set an API token directly:

export CLICKUP_TOKEN=your_token_here

Basic Usage

List all tasks from a specific ClickUp list:

quickup --team <team_id> --list <list_id>

Use interactive mode to navigate through your workspace hierarchy:

quickup -i

List tasks from the current sprint:

quickup sprint --team <team_id>

View details of a specific task:

quickup task <task_id>

Update a task's status:

quickup update <task_id> --status "In Progress"

Next Steps

  • Read the Installation guide for detailed installation instructions

  • Check the Commands Reference reference for all available CLI options

  • Explore Features to learn about filtering, grouping, and caching