clickup-ops

CLI ClickUp générée depuis OpenAPI, orientée scripts, CI et automatisations.

Principes

• Sortie JSON déterministe
• Une commande générée par route OpenAPI (nom canonique)
• Workflows custom et workflows déclaratifs (JSON/YAML)
• Sans sous-process shell pour enchaîner les appels API

Installation

Sans installation globale :

npx clickup-ops lists:create help

Installation globale :

npm install -g clickup-ops
# ou
pnpm add -g clickup-ops

Prérequis

• Node.js >=25

Configuration

Variables d'environnement :

• CLICKUP_API_TOKEN (requis)
• CLICKUP_WORKSPACE_ID (optionnel, mais utile pour certains workflows)
• CLICKUP_USER_ID (optionnel)

Exemple :

export CLICKUP_API_TOKEN=xxx
export CLICKUP_WORKSPACE_ID=9012498288
export CLICKUP_USER_ID=60665481

Ordre de résolution :

1. Options CLI
2. Variables d'environnement
3. Erreur bloquante

Commandes générées (OpenAPI)

Le CLI génère des commandes canoniques à la racine, par exemple :

clickup-ops authorization:get-authorized-user
clickup-ops tasks:get <task_id>
clickup-ops tasks:update <task_id> --body '{"status":"in progress"}'
clickup-ops lists:create <folder_id> --body '{"name":"Sprint 52"}'
clickup-ops tasks:list <list_id> --include-closed false

Paramètres

• path params : arguments positionnels (<task_id>, <list_id>, etc.)
• query params : options sans préfixe (--include-closed, --page, etc.)
• body :
  • --body '{...}'
  • --body-file payload.json

Aide des commandes

Deux syntaxes supportées :

clickup-ops tasks:list --help
clickup-ops tasks:list help

L'aide enrichie inclut :

• operationId
• méthode/path HTTP
• paramètres path/query
• body (content-types + champs top-level quand disponibles)
• exemple de commande

Workflows

Workflows intégrés

clickup-ops workflow sprint-create --folder-id <folder_id> --name "Sprint 52"
clickup-ops workflow backlog-to-sprint --backlog-list-id <id> --sprint-list-id <id>
clickup-ops workflow promote-top-priority --list-id <id> --to-status "in progress"

Workflows déclaratifs (JSON/YAML)

clickup-ops workflow run --file workflow.json --input '{"listId":"123"}'
clickup-ops workflow run --file workflow.yaml --input-file input.json

Notes :

• JSON fonctionne sans dépendance supplémentaire
• YAML nécessite l'installation optionnelle de yaml :

pnpm add yaml

Options globales

• --token <token>
• --workspace <id>
• --user <id>
• --header <name:value> (répétable, style curl)
• --json (sortie JSON stricte)
• --pretty (sortie lisible, défaut)

Format de sortie

Succès

{
  "success": true,
  "data": {}
}

Erreur

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "..."
  }
}

Codes de sortie

| Code | Signification | | ---- | ---------------- | | 0 | Succès | | 1 | Config error | | 2 | API error | | 3 | Validation error | | 4 | Unknown error |

Développement

pnpm install
pnpm codegen
pnpm lint
pnpm test:run
pnpm build

Docs projet

• PROJECT.md
• ARCHITECTURE.md
• ROADMAP.md
• CONTRIBUTING.md
• CHANGELOG.md