clickup-cli-reference

Document ClickUp Framework CLI commands, options, and usage examples.

Updated Nov 8, 2025
One-click install
npx skills add https://github.com/SOELexicon/clickup_framework --skill clickup-cli-reference
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: clickup-cli-reference
Source: https://github.com/SOELexicon/clickup_framework/tree/main/.claude/skills/cli-reference
Command: npx skills add https://github.com/SOELexicon/clickup_framework --skill clickup-cli-reference

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Navigating a powerful command-line interface can be daunting, with many commands, options, and aliases to remember. This Skill provides an exhaustive, searchable reference for the ClickUp Framework CLI, making it easy to find and use the exact command you need without memorizing complex syntax.

Core Features & Use Cases

  • Comprehensive Command Listing: Detailed breakdown of all cum commands, including short codes, usage, and descriptions for task, comment, and document management.
  • Context & Formatting Options: Explanations of context management, global formatting presets, and special keywords like current.
  • Workflow Examples: Practical examples for common ClickUp operations, from creating tasks to managing dependencies.
  • Use Case: A user wants to quickly find the command to add a comment to a task or set a task's priority. They can use this Skill to get the exact command, its options, and a quick example, saving time spent searching documentation or guessing syntax.

Quick Start

Show me the CLI command to create a new task, including options for setting its status and assigning it to a user.

Frequently Asked Questions about clickup-cli-reference

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a task using the ClickUp CLI with status and assignment options?

The ClickUp CLI task command creates tasks with options for status, assignment, and other properties. Use `cum task create` with flags like `--status` and `--assign` to set these attributes in a single command, eliminating manual setup steps in the UI.

What ClickUp CLI commands are available for managing tasks and comments?

The ClickUp CLI provides dedicated commands for task and comment management: `cum task` for CRUD operations, `cum comment` for adding and viewing comments, and `cum doc` for document handling. Each command supports multiple subcommands and formatting options.

Do I need to configure an API token to use the ClickUp CLI?

Yes, the ClickUp CLI requires a CLICKUP_API_TOKEN environment variable for authentication. Set this token before executing any commands to enable API access for task, comment, and document operations.

Can I use the ClickUp CLI in both installed and development environments?

Yes, the ClickUp CLI supports both installed contexts via `cum` and development contexts via `python -m`. Both modes execute the same commands and options, adapting to your workflow setup.

How do I quickly find the exact syntax for a specific ClickUp CLI command?

This reference provides a comprehensive, searchable breakdown of all `cum` commands, short codes, usage patterns, and examples. Look up your command by task type to get exact syntax, available options, and practical examples without memorizing complex syntax.

What context management and formatting options does the ClickUp CLI support?

The ClickUp CLI includes context management for switching between workspaces, global formatting presets for output customization, and special keywords like `current` for contextual operations. These streamline workflow across multiple ClickUp contexts.