@discountry/clickup-cli - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "@discountry/clickup-cli",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A globally installable ClickUp CLI for tasks, comments, and docs.",
@@ -5,0 +5,0 @@ "type": "module",

README_zh.md

@@ -5,9 +5,4 @@ # @discountry/clickup-cli
 
-一个可通过 `npm install -g` 全局安装的 ClickUp CLI。它基于当前仓库里的 skill 能力重新实现，但改成了真正的 npm CLI 包结构：
+用于任务、评论、文档的 ClickUp CLI。
 
-- 直接从全局环境变量读取配置
-- 保持 task、comment、doc 相关命令能力完整
-- 模块化拆分，便于继续维护和扩展
-- 自带 `node:test` 自动化测试
-
 ## 安装
@@ -17,12 +12,17 @@
 npm install -g @discountry/clickup-cli
+clickup --help
 ```
 
-安装后可以在系统里直接调用：
+安装 Codex skill：
 
 ```bash
-clickup --help
+npx skills add discountry/clickup-cli --skill clickup
+# 或
+npx skills add https://github.com/discountry/clickup-cli --skill clickup
 ```
 
-如果你只是本地联调当前仓库，仍然可以在仓库根目录执行：
+Skill 文档：[skills/clickup/README.md](./skills/clickup/README.md)
 
+本地安装当前仓库：
+
 ```bash
@@ -34,3 +34,3 @@ npm install -g .
 
-不依赖本地 `.env` 文件，直接读取 shell 环境变量：
+设置 shell 环境变量：
 
@@ -44,11 +44,11 @@ ```bash
 
-说明：
+变量说明：
 
-- `CLICKUP_API_TOKEN`：必填，ClickUp Personal API Token
-- `CLICKUP_WORKSPACE_ID`：可选，建议显式设置；未设置时会通过 API 自动获取第一个 workspace
-- `CLICKUP_TEAM_ID`：兼容旧 skill 的别名，可替代 `CLICKUP_WORKSPACE_ID`
-- `CLICKUP_USER_ID`：可选，未设置时会通过 API 自动获取当前用户
-- `CLICKUP_DEFAULT_LIST_ID`：可选，用于 `clickup create "Task title"` 这种简写
+- `CLICKUP_API_TOKEN`：必填。ClickUp Personal API Token。
+- `CLICKUP_WORKSPACE_ID`：可选。Workspace ID。
+- `CLICKUP_TEAM_ID`：可选。`CLICKUP_WORKSPACE_ID` 的别名。
+- `CLICKUP_USER_ID`：可选。当前用户 ID。
+- `CLICKUP_DEFAULT_LIST_ID`：可选。`clickup create "Task title"` 使用的默认 list。
 
-## 常用命令
+## 命令
 
@@ -85,3 +85,3 @@ ```bash
 
-支持 `--json` 原样输出 API 返回值，便于脚本集成。
+需要原始 API 输出时加 `--json`。
 
@@ -96,9 +96,9 @@ ## 开发
 
-入口文件：
+目录：
 
-- `bin/clickup.js`：全局命令入口
-- `src/cli/`：参数解析、命令注册、帮助信息
-- `src/services/`：任务、评论、文档、用户相关业务逻辑
-- `src/http/`：ClickUp HTTP 客户端
-- `src/utils/`：ID 解析、日期解析、Markdown 转换、输出格式化
-- `tests/`：自动化测试
+- `bin/clickup.js`：CLI 入口。
+- `src/cli/`：参数解析、命令注册、帮助信息。
+- `src/services/`：任务、评论、文档、用户服务。
+- `src/http/`：ClickUp HTTP 客户端。
+- `src/utils/`：ID 解析、日期解析、Markdown 转换、输出格式化。
+- `tests/`：自动化测试。

README.md

@@ -5,23 +5,23 @@ # @discountry/clickup-cli
 
-A globally installable ClickUp CLI for tasks, comments, and docs. It repackages the repository's existing skill capabilities into a proper npm CLI package structure:
+Global ClickUp CLI for tasks, comments, and docs.
 
-- Reads configuration directly from shell environment variables
-- Covers task, comment, and doc workflows
-- Keeps the codebase modular for ongoing maintenance
-- Includes automated tests with `node:test`
+## Install
 
-## Installation
-
 ```bash
 npm install -g @discountry/clickup-cli
+clickup --help
 ```
 
-After installation, invoke it directly:
+Install the Codex skill:
 
 ```bash
-clickup --help
+npx skills add discountry/clickup-cli --skill clickup
+# or
+npx skills add https://github.com/discountry/clickup-cli --skill clickup
 ```
 
-For local development against this repository:
+Skill docs: [skills/clickup/README.md](./skills/clickup/README.md)
 
+Local package install:
+
 ```bash
@@ -31,5 +31,5 @@ npm install -g .
 
-## Configuration
+## Configure
 
-This package does not rely on a local `.env` file. It reads from shell environment variables:
+Set shell environment variables:
 
@@ -45,9 +45,9 @@ ```bash
 
-- `CLICKUP_API_TOKEN`: required, your ClickUp Personal API Token
-- `CLICKUP_WORKSPACE_ID`: optional, recommended; if omitted the CLI falls back to the first workspace returned by the API
-- `CLICKUP_TEAM_ID`: legacy alias for `CLICKUP_WORKSPACE_ID`
-- `CLICKUP_USER_ID`: optional, auto-detected from the API when unset
-- `CLICKUP_DEFAULT_LIST_ID`: optional, used by shorthand commands such as `clickup create "Task title"`
+- `CLICKUP_API_TOKEN`: required. ClickUp Personal API Token.
+- `CLICKUP_WORKSPACE_ID`: optional. Workspace ID.
+- `CLICKUP_TEAM_ID`: optional. Alias for `CLICKUP_WORKSPACE_ID`.
+- `CLICKUP_USER_ID`: optional. Current user ID.
+- `CLICKUP_DEFAULT_LIST_ID`: optional. Default list for `clickup create "Task title"`.
 
-## Common Commands
+## Commands
 
@@ -84,3 +84,3 @@ ```bash
 
-Use `--json` to print raw API responses for scripting.
+Add `--json` for raw API output.
 
@@ -95,9 +95,9 @@ ## Development
 
-Entrypoints:
+Paths:
 
-- `bin/clickup.js`: global CLI entry
-- `src/cli/`: argument parsing, command registration, and help text
-- `src/services/`: task, comment, doc, and user services
-- `src/http/`: ClickUp HTTP client
-- `src/utils/`: ID parsing, date parsing, Markdown conversion, and output formatting
-- `tests/`: automated tests
+- `bin/clickup.js`: CLI entry.
+- `src/cli/`: argument parsing, command registration, help text.
+- `src/services/`: task, comment, doc, and user services.
+- `src/http/`: ClickUp HTTP client.
+- `src/utils/`: ID parsing, date parsing, Markdown conversion, output formatting.
+- `tests/`: automated tests.

src/utils/formatters.mjs

@@ -34,3 +34,3 @@ import { clickUpToMarkdown } from './markdown.mjs';
 export function formatPriority(priority) {
-  const value = typeof priority === 'object' ? priority.priority : priority;
+  const value = priority && typeof priority === 'object' ? priority.priority : priority;
   if (!value) {
@@ -37,0 +37,0 @@ return 'None';

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

66914

-1.05%

No dependency changes