Commands Reference

This page documents all available QuickUp! CLI commands and their options.

quickup login - Authenticate

Authenticate with ClickUp via OAuth. Opens your default browser and waits for the callback.

Synopsis

quickup login

Description

Opens the ClickUp authorization page in your browser and starts a local HTTP server on localhost:4242 to receive the OAuth callback. After you approve access in the browser, the token is exchanged and saved securely to ~/.quickup/auth.json (permissions: 0o600). The callback times out after 120 seconds if not completed.

Prerequisites

QuickUp! ships without any bundled credentials, so you must point it at your own ClickUp OAuth app. Create one at https://app.clickup.com/settings/apps with the redirect URI http://localhost:4242, then export its credentials (or put them in a .env file):

export QUICKUP_CLIENT_ID=your_client_id
export QUICKUP_CLIENT_SECRET=your_client_secret

If either variable is missing, quickup login exits with code 6 and prints the setup hint instead of opening a browser.

Examples

Log in using the credentials exported above:

quickup login

Or read them from a .env file in the current directory:

echo 'QUICKUP_CLIENT_ID=your_client_id' >> .env
echo 'QUICKUP_CLIENT_SECRET=your_client_secret' >> .env
quickup login

quickup logout - Remove Stored Credentials

Remove the stored OAuth token from disk.

Synopsis

quickup logout

Description

Deletes ~/.quickup/auth.json. This only removes the OAuth token — tokens set via the CLICKUP_TOKEN environment variable or a .env file are not affected.

Examples

quickup logout

quickup (default) - List Tasks

List all tasks from a ClickUp list, grouped by status.

Synopsis

quickup [OPTIONS]

Options

--team

Team ID (required when multiple teams exist)

--space

Space ID

--project

Project ID

--list

List ID

--assignee

Filter by assignee username (case-insensitive)

--priority

Filter by priority (low, normal, high, urgent)

--due-before

Filter tasks due before date (YYYY-MM-DD)

--group-by

Group by status (default), assignee, or priority

--no-cache

Bypass cache and fetch from API

-i, --interactive

Enable interactive mode for Team/Space/Project/List selection

Examples

Basic usage:

quickup --team 12345 --list 67890

Filter by assignee and priority:

quickup --team 12345 --list 67890 --assignee john --priority high

Group by assignee:

quickup --team 12345 --list 67890 --group-by assignee

Interactive mode:

quickup -i

Bypass cache:

quickup --team 12345 --list 67890 --no-cache

quickup sprint - Current Sprint Tasks

Auto-detects the current sprint list by searching for lists containing "sprint" or "iteration" in the name.

Synopsis

quickup sprint [OPTIONS]

Options

Same options as quickup command, except --list is not needed (auto-detected).

Examples

List tasks from current sprint:

quickup sprint --team 12345

Filter sprint tasks by assignee:

quickup sprint --team 12345 --assignee jane

Group sprint tasks by priority:

quickup sprint --team 12345 --group-by priority

quickup task - Task Details

Show detailed information about a specific task.

Synopsis

quickup task <task_id> [OPTIONS]

Arguments

task_id

ClickUp task ID

Options

--team

Team ID (required if multiple teams exist)

--comments

Fetch and display task comments

-i, --interactive

Enable interactive mode

Examples

Show task details:

quickup task 123456

With team specification:

quickup task 123456 --team 12345

Include comments:

quickup task 123456 --comments

quickup update - Update Task Status

Update the status of a specific task.

Synopsis

quickup update <task_id> [OPTIONS]

Arguments

task_id

ClickUp task ID

Options

--status

New status name (e.g., "To Do", "In Progress", "Done")

--team

Team ID (required if multiple teams exist)

-i, --interactive

Enable interactive mode

Examples

Update task status:

quickup update 123456 --status "In Progress"

With team specification:

quickup update 123456 --status "Done" --team 12345

quickup comment - Post a Comment

Post a comment on a specific task. Provide text via --text or pipe from stdin.

Synopsis

quickup comment <task_id> [OPTIONS]

Arguments

task_id

ClickUp task ID

Options

--text

Comment text to post. If omitted, reads from stdin.

--notify-all

Notify all task watchers (default: false)

Examples

Post a comment:

quickup comment 123456 --text "This looks good, merging now"

Notify all watchers:

quickup comment 123456 --text "Attention everyone" --notify-all

Pipe comment from stdin:

echo "Comment from a script" | quickup comment 123456