clickup-cli-reference

# ClickUp Framework CLI Reference

Quick reference for the ClickUp Framework CLI (`cum` / `clickup`)

## Installation

### Install from GitHub (Latest)
```bash
pip install --upgrade --force-reinstall git+https://github.com/SOELexicon/clickup_framework.git
```

### Verify Installation
```bash
cum --version
# or
clickup --version
```

### Required: API Token Setup
```bash
export CLICKUP_API_TOKEN="your_token_here"
# Or add to ~/.bashrc or ~/.zshrc for persistence
```

## Command Invocation

**In Development Environment (working in the repo):**
```bash
python -m clickup_framework.cli <command> [args]
```

**In Installed Environment:**
```bash
cum <command> [args]
# or
clickup <command> [args]
```

**How to determine which to use:**
1. First check if `cum` command is available with: `which cum` or `command -v cum`
2. If NOT available (returns empty/error), use: `python -m clickup_framework.cli`
3. If available, use: `cum`

## Quick Reference: All Short Codes

**View:** `h` `ls` `l` `c` `f` `fil` `d` `st` `a`
**Context:** `set` `show` `clear`
**Tasks:** `tc` `tu` `td` `ta` `tua` `tss` `tsp` `tst` `tad` `trd` `tal` `trl`
**Comments:** `ca` `cl` `cu` `cd`
**Docs:** `dl` `dg` `dc` `du` `de` `di` `pl` `pc` `pu`

## View Commands

| Command | Short Codes | Usage | Description |
|---------|-------------|-------|-------------|
| `hierarchy` | `h` `list` `ls` `l` | `cum h <list_id\|--all>` | Hierarchical parent-child tree view |
| `clist` / `container` | `c` | `cum c <list_id>` | Container hierarchy (Space→Folder→List) |
| `flat` | `f` | `cum f <list_id>` | Flat list view |
| `filter` | `fil` | `cum fil <list_id> [--status\|--priority\|--tags\|--assignee]` | Filtered task view |
| `detail` | `d` | `cum d <task_id> [list_id]` | Detailed single task view |
| `stats` | `st` | `cum st <list_id>` | Task statistics & distribution |
| `assigned` | `a` | `cum a [--user-id UID] [--team-id TID]` | Your assigned tasks, sorted by difficulty |
| `demo` | | `cum demo [--mode MODE]` | Demo mod