cu

README

cu - ClickUp CLI

Note: cu is an unofficial, community-maintained project and is not affiliated with or endorsed by ClickUp.

A GitHub CLI-inspired command-line interface for ClickUp.

Overview

cu is a command-line tool that brings the power and convenience of GitHub's gh CLI to ClickUp. It allows developers to seamlessly manage tasks, lists, spaces, and other ClickUp resources directly from the terminal.

Features

• GitHub CLI-like Interface: Familiar command structure for developers who use gh
• Task Management: Create, view, update, and manage tasks from the command line
• Comment Management: Add, list, and delete comments on tasks with user assignment
• Cache Management: Optimize performance with intelligent caching and cache control commands
• Project Configuration: Set project-specific defaults with .cu.yml configuration files
• API Passthrough: Direct access to ClickUp API endpoints for advanced operations
• Export Functionality: Export tasks to CSV, JSON, or Markdown formats
• Multiple Output Formats: Support for table, JSON, YAML, and CSV output
• Shell Completions: Full support for bash, zsh, fish, and PowerShell
• Cross-Platform: Works on macOS, Linux, and Windows

Installation

Homebrew (macOS)

brew install timimsms/cu/cu

Installs from the timimsms/homebrew-cu tap. Available with the first tagged release.

Go

go install github.com/timimsms/cu/cmd/cu@latest

npm

Planned as @timimsms/cu (not yet published).

Direct Download

Download the latest release from the releases page.

Quick Start

1. Authenticate with ClickUp:

cu auth login

1. List your tasks:

cu task list

1. Create a new task:

cu task create

Command Examples

Task Management

# List tasks in current space
cu task list

# Create a new task
cu task create

# View task details
cu task view <task-id>

# Export tasks to CSV
cu export tasks --format csv > tasks.csv

Comment Management

# Add a comment to a task
cu comment <task-id> -m "This is my comment"

# List comments on a task
cu comment list <task-id>

# Add comment with assignee
cu comment <task-id> -m "Please review" --assignee user@example.com

Cache Management

# View cache statistics
cu cache info

# Clear all cache
cu cache clear

# Clean expired cache entries
cu cache clean

Project Configuration

# Initialize project config
cu config init

# Set default list for project
cu config set default.list "My List ID"

# View all configuration
cu config list

API Access

# Get workspace info
cu api /team

# Create a task via API
cu api /list/abc123/task -X POST -d '{"name": "New Task"}'

# Get tasks with query parameters
cu api "/list/abc123/task?archived=false"

Documentation

Full documentation is available at https://timimsms.github.io/cu/

Quick Links

• Command Reference
• Task Management
• Configuration
• Authentication

Development

See CONTRIBUTING.md for development setup and contribution guidelines.

License

This project is licensed under the MIT License - see the LICENSE file for details.