clickup-cli: Instructions file for Claude Code

clickup-cli

Rust CLI for the ClickUp API, optimized for AI agent consumption. Covers all ~130 endpoints across 28 resource groups and 4 utility commands.

Build & Test

cargo build                    # Build
cargo test                     # Run all tests
cargo test --test test_cli     # CLI smoke tests only
cargo test --test test_output  # Output formatting tests only
cargo run -- --help            # Show help

Architecture

• Ships two binaries: clickup-cli (canonical) and clkup (short alias, identical behaviour)
• Entry: src/main.rs → src/lib.rs
• Commands: src/commands/{resource}.rs — one file per API resource group
• Models: src/models/{resource}.rs — serde structs for API responses
• Core: src/client.rs (HTTP + retry), src/config.rs (TOML), src/output.rs (formatting), src/error.rs (errors)

CLI Pattern

clickup-cli <resource> <action> [ID] [flags]

Command Groups

Core (v0.1)

• setup — configure API token and default workspace
• auth — whoami, check, login, logout, status
• workspace — list, seats, plan
• space — list, get, create, update, delete
• folder — list, get, create, update, delete
• list — list, get, create, update, delete, add-task, remove-task
• task — list, search, get, create, update, delete, time-in-status, add-tag, remove-tag, add-dep, remove-dep, link, unlink, move, set-estimate, replace-estimates

Collaboration (v0.2)

• checklist — create, update, delete, add-item, update-item, delete-item
• comment — list, create, update, delete, replies, reply
• tag — list, create, update, delete
• field — list, set, unset
• task-type — list
• attachment — list, upload

Tracking (v0.3)

• time — list, get, current, create, update, delete, start, stop, tags, add-tags, remove-tags, rename-tag, history
• goal — list, get, create, update, delete, add-kr, update-kr, delete-kr
• view — list, get, create, update, delete, tasks
• member — list
• user — invite, get, update, remove