Yokadi 使用与技术文档

1. 安装指南

Yokadi 是一个基于命令行的 TODO 列表工具，它使用 SQLite 作为数据库支持。Yokadi 适用于任何类 Unix 系统，对 Windows 系统也有一定支持，但未经过充分测试。

Yokadi 需要Python 3.4 或更高版本以及一些其他模块。可以使用以下命令安装这些模块：

pip install -r requirements.txt

此外，还有一些可选模块列在 extra-requirements.txt 文件中，可以用于 Yokadi 守护进程。安装这些模块可以使用以下命令：

pip install -r extra-requirements.txt

2. 项目使用说明

Yokadi 允许用户通过命令行管理项目和相关任务。下面是一个简单的 Yokadi 会话示例：

启动 Yokadi：

./bin/yokadi

创建第一个任务：

yokadi> t_add 项目名 任务描述

添加更多任务：

yokadi> t_add _ 任务描述

其中 _ 表示使用最近的项目。

列出项目中的任务：

yokadi> t_list 项目名

完成任务：

yokadi> t_mark_done 任务ID

查看任务详情：

yokadi> t_show 任务ID

3. 项目API使用文档

Yokadi 的命令行界面提供了多种命令用于管理任务和项目。以下是一些常用的命令：

• t_add：添加新任务
• t_list：列出任务
• t_mark_done：标记任务为完成
• t_show：显示任务详情
• t_due：设置任务截止日期
• t_recurs：设置周期性任务

每个命令都有详细的帮助信息，可以通过 help <命令> 来访问。

4. 项目安装方式

Yokadi 可以通过以下步骤安装：

1. 确保系统中安装了 Python 3.4 或更高版本。
2. 使用 pip 安装必需的模块：

pip install -r requirements.txt

3. 如果需要守护进程功能，安装额外模块：

pip install -r extra-requirements.txt

4. 将 Yokadi 的可执行文件 bin/yokadi 添加到系统路径，或者创建一个别名以便于使用。

启动 Yokadi 后，可以按照上面的使用说明开始管理任务。