QuickUp! Documentation

A simple, lightweight, and beautiful console-based client for ClickUp.

Quick Start

Install QuickUp!:

pip install quickup

Configure your ClickUp API token:

export CLICKUP_TOKEN=your_token_here

Run the tool:

quickup --help

Feature Highlights

CLI Commands

• quickup - List tasks from a ClickUp list with color-coded status groups

• quickup sprint - Auto-detect and list tasks from the current sprint

• quickup task <id> - Show detailed information about a specific task

• quickup update <id> - Update a task's status

Features

• Task filtering by assignee, priority, or due date

• Task grouping by status, assignee, or priority

• Interactive mode for navigating Team → Space → Project → List hierarchy

• Disk-based caching for improved performance (24h for teams/lists, 5min for tasks)

• Color-coded output matching ClickUp status colors

Documentation Contents

Getting Started:

• Quick Start
  • Installation
  • Authentication
  • Basic Usage
  • Next Steps
• Installation
  • System Requirements
  • Installation Steps
  • Configuration
  • Getting Your ClickUp API Token (for manual setup)
  • Upgrading
  • Uninstallation

User Guide:

• Commands Reference
  • quickup login - Authenticate
  • quickup logout - Remove Stored Credentials
  • quickup (default) - List Tasks
  • quickup sprint - Current Sprint Tasks
  • quickup task - Task Details
  • quickup update - Update Task Status
  • quickup comment - Post a Comment
• Features
  • Authentication
  • Task Listing
  • Filtering
  • Grouping
  • Task Comments
  • Sprint Detection
  • Interactive Mode
  • Caching
  • Output Format

Developer Guide:

• API Reference
  • cli.main
  • cli.api_client
  • cli.renderer
  • cli.config
  • cli.cache
  • cli.auth
  • cli.exceptions
• Troubleshooting
  • Token Errors
  • Team Errors
  • List Errors
  • Network Errors
  • API Errors
  • Cache Issues
  • Exit Codes Reference
  • Getting Help
• Contributing Guide
  • Setting Up the Development Environment
  • Running the Test Suite
  • Using Pre-commit
  • Building Documentation
  • Serving Documentation Locally
  • Coverage Reports
  • Development Scripts Reference

Indices and tables

• Index

• Module Index

• Search Page