# @doist/todoist-cli 中文文档

规范地址：https://npmcn.com/package/%40doist/todoist-cli/

版本：5\.13\.0
npm 元数据更新时间：2026-11-11T15:09:41.970Z
中文译文更新时间：2026-11-12T14:53:23.981Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40doist/todoist-cli
原文对照：https://npmcn.com/package/%40doist/todoist-cli/?lang=original
项目主页：https://github.com/todoist/todoist-cli#readme
源码仓库：https://github.com/todoist/todoist-cli

弃用说明：Moved to @todoist/cli\. Run: npm uninstall -g @doist/todoist-cli && npm install -g @todoist/cli

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：2 MB，1059 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：12 个
- 首次发布：2026-01-19T17:29:39.102Z
- 最新版本发布：2026-11-11T14:45:54.573Z
- 近 30 天下载量：30047（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：217（近 12 个月 217 个）

## 中文简介

Todoist 的脚本 CLI 类型

## 安装

```sh
npm install @doist/todoist-cli
```

也可以使用：`pnpm add @doist/todoist-cli`、`yarn add @doist/todoist-cli`、`bun add @doist/todoist-cli`

## README

![Todoist CLI](https://npmcn.com/package/%40doist/todoist-cli/icons/td-cli.png)

# 托多主义CLI

Todoist 的命令行界面 .

## 安装

> ```bash
> npm install -g @doist/todoist-cli
> ```

### 代理技能

为您的编码代理安装技能 :

```bash
td skill install claude-code
td skill install codex
td skill install copilot
td skill install cursor
td skill install gemini
td skill install pi
td skill install universal
```

技能安装到 `~/<agent-dir>/skills/todoist-cli/SKILL.md` (例如:. `~/.claude/` 为克来德码, `~/.agents/` (为普世等). 在更新CLI时,所安装的技能会被自动更新. 这个 `universal` 代理与 Amp 、 OpenCode 和其他从 `~/.agents/`。 。 。 .

这个 `gemini` 代理安装到 `~/.gemini/config/skills/todoist-cli/SKILL.md`,Antigravity,Antigravity CLI和Antigravity IDE等读取的全球位置. 用于项目范围抗重力技能 `td skill install universal --local`,写给 `.agents/skills/` ——工作空间目录"抗重力"读取.

```bash
td skill list
td skill uninstall <agent>
```

## 卸载

首先,删除任何已安装的代理技能:

```bash
td skill uninstall <agent>
```

然后解开CLI:

```bash
npm uninstall -g @doist/todoist-cli
```

## 本地设置

```bash
git clone https://github.com/todoist/todoist-cli.git
cd todoist-cli
npm install
npm run build
npm link
```

这使得 `td` 命令可在全球范围使用.

## 设置

```bash
td auth login
```

此打开您的浏览器以认证 Todoist 。 一旦批准,该令牌存储在您的OS证书管理器中:

-   macOS: 键链
-   窗口: 证书管理器
-   Linux: 特务/libsecret

默认需要安全存储 。 如果无法使用, 在未写入磁盘证书的情况下登录失败 。 要明确使用纯文本配置文件存储, 通过 `--credential-store=plaintext`;CLI在这样写证书时总是会打印出警告. 现有的平正文字符号在下一次 CLI 从配置文件成功读取时自动迁移 .

仅读 OAuth 符号( 镜片) `data:read`),运行:

```bash
td auth login --read-only
```

要在简写中明确保存证书而不是OS证书管理器:

```bash
td auth login --credential-store=plaintext
```

在只读模式下,更改 todoist数据(创建/更新/删除/完成/移动/存档等)的命令被CLI屏蔽.

一些命令需要选入 OAuth 范围,请通过 `--additional-scopes=<list>` (合并分离):

```bash
td auth login --additional-scopes=app-management   # td apps ...
td auth login --additional-scopes=backups           # td backup ...
td auth login --additional-scopes=billing           # td billing ...
```

运行 `td auth login --help` 完整名单。 当一个命令因没有范围而失败时,错误提示了重新登录命令,保留了原来使用的哪个旗帜.

### 替代方法

**手动符号 :** 获取您的 API 令牌 [待办事宜设置 > 集成 > 开发者](https://todoist.com/app/settings/integrations/developer)数字 :

```bash
td auth token "your-token"
```

手动符也默认使用系统证书管理器. 明确保存一个 中,添加 `--credential-store=plaintext`; CLI 打印出写入后的警告 .

**环境变量:**

```bash
export TODOIST_API_TOKEN="your-token"
```

`TODOIST_API_TOKEN` 总是优先于存储的符号.

注:外部提供的代号`TODOIST_API_TOKEN` 或者说 `td auth token`)被视为范围不明,并假定具有写作能力。 目前 CLI 无法为这些符号自动检测 OAuth 范围 .

### Auth 命令

```bash
td auth status   # check if authenticated + mode (read-only/read-write/unknown)
td auth logout   # remove saved token and auth metadata
```

要切换回正常的写入权限, 重新运行 :

```bash
td auth login
```

## 使用量

```bash
td add "Buy milk tomorrow #Shopping"   # quick add with natural language
td today                               # tasks due today + overdue
td inbox                               # inbox tasks
td task list                           # all tasks
td task list --project "Work"          # tasks in project
td task list --project "Work" --ids-only # one task ID per line
td project list                        # all projects
td status set "Deep work" --emoji 🎯 --for 2h   # shared status; td status clear to remove
td task view https://app.todoist.com/app/task/buy-milk-8Jx4mVr72kPn3QwB  # paste a URL
```

运行 `td --help` 或者说 `td <command> --help` 更多选择.

接受支持的列表命令 `--ids-only` 当每个结果都有稳定的ID。 它印出一个 每行的ID,没有人类可读的空状态文本. 当存在更多页面时, 页化 所以对于管道来说 保持安全. `--ids-only`, (中文(简体) ), `--json`,以及 `--ndjson` 两者相互排斥.

## 无障碍

对于依赖屏幕阅读器或无法区分颜色的用户,请使用 `--accessible` 旗帜或设置 `TD_ACCESSIBLE=1` 在颜色编码输出中添加文本标签:

```bash
td today --accessible
# or
export TD_ACCESSIBLE=1
td today
```

当活动时,到期日为 a `due:` 前缀, 最后期限得到一个 `deadline:` 前缀,持续时间得到一个 `~` 前缀,最爱的项目获得一个 `★` 后缀。 没有旗帜的默认输出不变.

## 扩展

扩展名添加命令到 `td`扩展名 `td-<name>` 运行为 `td <name>`,并且可以用任何语言书写:

```bash
td extension install owner/td-standup   # from GitHub
td standup
td extension list
```

写你自己的,从 `td extension create <name>` 看着 [文件/扩展本.md](https://npmcn.com/package/%40doist/todoist-cli/docs/extensions.md)。 。 。 .

## 贝壳补全

标签完成可以提供:

```bash
td completion install        # prompts for shell
td completion install bash   # or: zsh, fish, pwsh
```

重新启动您的 shell 或源代码您的配置文件以激活 。 要删除 :

```bash
td completion uninstall
```

## 发展

```bash
npm install
npm run build       # compile
npm run dev         # watch mode
npm run type-check  # type check
npm run fix         # auto-fix lint + format
npm test            # run tests
```

## 常见问题

### @doist/todoist-cli 是什么？

Todoist 的脚本 CLI 类型注意：该包已被作者标记为弃用——Moved to @todoist/cli\. Run: npm uninstall -g @doist/todoist-cli && npm install -g @todoist/cli

### 如何安装 @doist/todoist-cli？

在项目目录运行 npm install @doist/todoist-cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 td，可以用 npx td 直接运行。

### @doist/todoist-cli 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @doist/todoist-cli 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @doist/todoist-cli 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @doist/todoist-cli 可以商用吗？

@doist/todoist-cli 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @doist/todoist-cli 的下载量有多少？

根据 npm 官方下载统计，@doist/todoist-cli 在 2026/10/13 – 2026/11/11 这 30 天内被下载 30,047 次，日均约 1,002 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @doist/todoist-cli 还在维护吗？

最新版本 5\.13\.0 发布于 2026/11/11（2 天前）；至今共发布 217 个版本，其中过去 12 个月发布了 217 个；首次发布于 2026/01/20。作者已将其标记为弃用，新项目建议寻找替代方案。