Installation

System Requirements

Python 3.10 or higher
ClickUp API token
pip or uv package manager

Installation Steps

Install from PyPI:
```
pip install quickup
```
Alternatively, install using uv:
```
uv pip install quickup
```
Verify the installation:
```
quickup --help
```

Configuration

After installation, authenticate with ClickUp using one of the methods below.

Option 1: OAuth Login (Recommended)

Run the login command to authenticate via your browser:

quickup login

This opens ClickUp in your default browser. After approving access, your credentials are saved automatically to ~/.quickup/auth.json (permissions: 0o600). No manual token management needed.

To sign out:

quickup logout

Option 2: Environment Variable

For automation or CI environments, export the token in your shell:

export CLICKUP_TOKEN=your_token_here

To make this permanent, add it to your shell configuration file (e.g., ~/.bashrc, ~/.zshrc):

echo 'export CLICKUP_TOKEN=your_token_here' >> ~/.zshrc

Option 3: .env File

Create a .env file in your project directory:

CLICKUP_TOKEN=your_token_here

QuickUp! will automatically load the token from this file.

Note

When both an environment/.env token and an OAuth token exist, the environment token takes precedence.

Getting Your ClickUp API Token (for manual setup)

Log in to your ClickUp account
Go to Settings → Apps → ClickUp API
Click on "Authorize"
Copy your API token
Store it securely

Upgrading

To upgrade to the latest version:

pip install --upgrade quickup

Uninstallation

To remove QuickUp!:

pip uninstall quickup