clickup-cli AGENTS.md

Repository guidance for cup, a command-line tool for ClickUp, a task-management service. It describes interactive terminal use, Markdown output for AI context, JSON output, and the project's testing and release skills.

In plain words
What is it for?
Use it when changing ClickUp task commands, interactive prompts, Markdown or JSON output, TypeScript code, tests, package releases, Homebrew publishing, or GitHub releases.
Why use it?
It clarifies which command name and output format to use and points agents to the repository's required procedures for tests and releases.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/krodak/clickup-cli/agents-md
Clone the repo
git clone --depth 1 https://github.com/krodak/clickup-cli

Made for: Codex, OpenCode.

Per session 1,959 This file is loaded in full into every session.
When invoked 1,959 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.01959 $0.01959
Opus 5 $0.00979 $0.00979
Sonnet 5 $0.00392 $0.00392
Haiku 4.5 $0.00196 $0.00196

Measured 2d ago against content hash dc021ce4e55b, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

clickup-cli AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 163 lines

How it starts

The opening of the file, as written. The whole thing — 163 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md

Project Overview

@krodak/clickup-cli (cup) - a ClickUp CLI for AI agents and humans. TypeScript, ESM-only, Node 22+. Dual-mode output: TTY runs interactive prompts via @inquirer/prompts (task picker with vim-style j/k navigation, select/confirm dialogs); piped outputs Markdown optimized for AI context windows; --json forces structured JSON in either mode. The binary is cup - the previous cu name was retired to avoid conflict with the Unix cu(1) utility.

Project Skills

This repo includes project-level agent skills in .agents/skills/:

Skill When to use
releasing-clickup-cli Releasing a new version (npm, Homebrew, GitHub Release, skill sync). Follow this skill exactly - it prevents version/docs/metadata mistakes.
testing-clickup-cli Running tests, adding test coverage, debugging failures. Documents unit test patterns, e2e workspace fixtures, and the metadata sync test.

Use these skills for releasing and testing instead of the sections below - they have full step-by-step instructions.

External Skills

  • typescript-pro - for all TypeScript work. The project uses strict mode, verbatimModuleSyntax, noUncheckedIndexedAccess, and typescript-eslint recommendedTypeChecked rules.
  • cli-developer - for CLI design, argument parsing, interactive prompts, and shell completions. The project uses Commander for CLI framework, @inquirer/prompts for interactive UI, and chalk for colors.

Tech Stack

Tool Purpose
TypeScript strict, ES2022 target, NodeNext modules
tsup Build - single ESM bundle to dist/index.js
Vitest Unit tests (tests/unit/) and e2e tests (tests/e2e/)
ESLint 10 Flat config with typescript-eslint recommendedTypeChecked
Prettier No semicolons, single quotes, trailing commas, 100 print width
Commander CLI framework
@inquirer/prompts Interactive terminal UI (task picker, select/confirm prompts)
chalk Terminal colors (TTY only)

Read the full file on GitHub · 163 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 163 lines · 1,959 tokens per session scan A dc021ce4e55b

Subscribe to this mod's changes

clickup-cli AGENTS.md is an instructions file published in the GitHub repository krodak/clickup-cli (115 stars, last pushed 2d ago), licensed MIT. It adds 1,959 tokens to every session, about $0.0098 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.