Back to Details

todoing-install

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

todoing-install

todoing-install

—

安装
todoing
并将其集成到项目中的指南，以便AI Agents可使用它进行任务追踪。

—

要求

A guide for installing 
todoing
and integrating it into a project so that AI agents can use it for task tracking.
  • Python 3.11+
  • pip
    、
    pipx
    或
    uv
    （任何Python包管理器均可）

Requirements

安装
uv
（一次性操作，若未安装）

  • Python 3.11+
  • pip
    , 
    pipx
    , or 
    uv
    (any Python package manager works)
如果尚未安装
uv
，请先安装：
bash
curl -LsSf https://astral.sh/uv/install.sh | sh
或通过pip安装：
pip install uv
。使用
uv --version
验证安装。

Install 
uv
(one-time, if not installed)

安装方式

—

推荐方式：
uv tool install todoing

If you don't have 
uv
yet, install it first:
bash
curl -LsSf https://astral.sh/uv/install.sh | sh
Or via pip: 
pip install uv
. Verify with 
uv --version
.
bash
uv tool install todoing
优点：环境隔离、速度快，无需激活虚拟环境即可使用。

Install methods

通过pipx安装

Recommended: 
uv tool install todoing

—
bash
uv tool install todoing
Pros: isolated environment, fast, works without activating a venv.
bash
pipx install todoing
pipx ensurepath              # 将pipx管理的工具添加至PATH
优点：环境隔离、广泛可用。需要提前安装
pipx
。

Via pipx

通过pip安装

bash
pipx install todoing
pipx ensurepath              # add pipx-managed tools to PATH
Pros: isolated environment, widely available. Requires 
pipx
.
bash
pip install todoing
优点：无需额外工具。缺点：会污染全局Python环境；建议使用虚拟环境。

Via pip

验证安装

bash
pip install todoing
Pros: no extra tools. Cons: pollutes the global Python environment; use a virtualenv if possible.
bash
todoing --help
todoing version
你应该能看到使用信息和版本号。

Verify installation

故障排查

bash
todoing --help
todoing version
You should see usage info and the version number.
症状可能的解决方法
todoing: command not found
安装目录未在
PATH
中。对于
uv tool install
/
pipx
：将
~/.local/bin/
添加至
PATH
（在shell配置文件中添加
export PATH="$HOME/.local/bin:$PATH"
），或运行
pipx ensurepath
。
Permission denied
不要使用
sudo pip install
。改用
uv tool install
或
pipx
——它们支持用户隔离。
No module named yaml
安装已损坏。重新安装：
uv tool install todoing --reinstall
或
pipx reinstall todoing
。
Error: No such command
你使用的是旧版本。升级：
uv tool upgrade todoing
或
pipx upgrade todoing
或
pip install --upgrade todoing
。

Troubleshooting

设置Agent技能

SymptomLikely fix
todoing: command not found
The install directory isn't on 
PATH
. For 
uv tool install
/ 
pipx
: add 
~/.local/bin/
to 
PATH
(
export PATH="$HOME/.local/bin:$PATH"
in shell rc), or run 
pipx ensurepath
.
Permission denied
Don't 
sudo pip install
. Use 
uv tool install
or 
pipx
instead — they respect user isolation.
No module named yaml
Corrupted install. Reinstall: 
uv tool install todoing --reinstall
or 
pipx reinstall todoing
.
Error: No such command
You have an old version. Upgrade: 
uv tool upgrade todoing
or 
pipx upgrade todoing
or 
pip install --upgrade todoing
.
为了让AI Agents（如opencode、Claude Code）能够使用
todoing
，需要安装对应的技能。该技能位于
.agents/skills/todoing/SKILL.md
。

Setting up the agent skill

安装技能

For AI agents (opencode, Claude Code) to use 
todoing
, they need the skill installed. The skill lives at 
.agents/skills/todoing/SKILL.md
.
如果你所在的仓库包含
.agents/skills/todoing/
，则技能已可用——Agent可通过
skill todoing
加载它。
对于其他仓库，复制技能目录：
bash
cp -r /path/to/todoing/.agents/skills/todoing /your/repo/.agents/skills/
或在Agent的配置文件（如opencode的
AGENTS.md
）中引用它。

Install the skill

向项目添加todoing使用说明

If you're inside the repo that contains 
.agents/skills/todoing/
, the skill is already available — the agent can load it with 
skill todoing
.
For other repos, copy the skill directory:
bash
cp -r /path/to/todoing/.agents/skills/todoing /your/repo/.agents/skills/
Or reference it in the agent's config (e.g. opencode's 
AGENTS.md
).
在引导项目使用
todoing
时，询问用户：
"是否需要我将todoing使用说明添加至项目的
AGENTS.md
（或
CLAUDE.md
）中，以便AI Agents自动知晓使用
todoing
进行任务管理？"
如果用户同意，在项目配置文件中添加如下内容：
markdown
undefined

Adding todoing instructions to the project

使用todoing进行任务管理

When onboarding a project to use 
todoing
, ask the user:
"Do you want me to add todoing instructions to your project's 
AGENTS.md
(or 
CLAUDE.md
) so that AI agents automatically know to use 
todoing
for task management?"
If they say yes, add a section like this to the project's config file:
markdown
undefined
本项目使用todoing进行任务追踪。任务存储在
.todoing/tasks/
中。请始终使用
todoing
CLI——除非出现问题，否则请勿直接读取
.todoing/
文件。
快速参考：
  • todoing ls -n 5
    — 查看最近的任务
  • todoing status <id> in_progress
    — 开始处理任务
  • todoing status <id> done
    — 标记任务完成
  • todoing add "title" -l label
    — 创建任务
  • todoing append <id> "progress note"
    — 记录进度

该配置文件应放置在项目根目录，命名为`AGENTS.md`（适用于opencode）或`CLAUDE.md`（适用于Claude Code），以用户偏好或已有的文件为准。

Task management with todoing

—
This project uses todoing for task tracking. Tasks live in 
.todoing/tasks/
. Always use the 
todoing
CLI — never read 
.todoing/
files directly unless something is broken.
Quick reference:
  • todoing ls -n 5
    — see recent tasks
  • todoing status <id> in_progress
    — start work on a task
  • todoing status <id> done
    — mark complete
  • todoing add "title" -l label
    — create a task
  • todoing append <id> "progress note"
    — log progress

This config should be placed in the project root as `AGENTS.md` (for opencode)
or `CLAUDE.md` (for Claude Code), whichever the user prefers or already has.
—