kanban.bash 项目教程

kanban.bash 项目教程

kanban.bash commandline asciii kanban board for minimalist productivity hackers & managers (csv-based) #scriptable #nestable #statistics #singlefile #shellscript 项目地址: https://gitcode.com/gh_mirrors/ka/kanban.bash

1. 项目目录结构及介绍

kanban.bash/
├── kanban
├── kanban.completion
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
└── test

• kanban: 项目的核心脚本文件，用于初始化、添加、显示和管理看板任务。
• kanban.completion: 自动补全脚本，方便用户在命令行中快速输入命令。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被版本控制。
• .travis.yml: Travis CI 配置文件，用于自动化测试和持续集成。
• LICENSE: 项目许可证文件，本项目使用 AGPL-3.0 许可证。
• README.md: 项目说明文件，包含项目的简介、安装和使用方法。
• test: 测试目录，包含项目的测试脚本和测试数据。

2. 项目启动文件介绍

kanban 是项目的启动文件，它是一个命令行工具，用于管理看板任务。以下是 kanban 脚本的主要功能：

• 初始化看板: kanban init 命令用于在当前目录初始化一个新的看板。
• 添加任务: kanban add 命令用于交互式地添加新任务，也可以通过命令行参数直接添加任务。
• 显示看板: kanban show 命令用于显示当前的看板状态，支持按状态过滤显示。
• 编辑任务: kanban <id> 命令用于编辑或更新指定 ID 的任务。
• 更新任务状态: kanban <id> <status> 命令用于更新任务的状态。
• 列出任务: kanban list 命令用于列出所有任务，kanban <status> 命令用于按状态列出任务。
• 统计信息: kanban stats 命令用于查看任务的统计信息，支持按状态和标签统计。
• 编辑 CSV 文件: kanban csv 命令用于直接编辑看板的 CSV 数据文件。

3. 项目配置文件介绍

项目的配置文件位于用户主目录下的 ~/.kanban/kanban.conf 文件中。该文件在首次运行 kanban init 命令时自动生成，包含以下配置项：

• 看板状态: 定义看板的状态列表，例如 TODO, DOING, HOLD, DONE 等。
• 任务限制: 可以设置每个状态下的任务数量限制，防止任务过多导致管理混乱。
• 终端宽度: 可以设置看板在终端中显示的最大宽度，以适应不同尺寸的终端窗口。
• 颜色和格式: 可以配置是否启用颜色显示和特殊字符，以提高可读性。

配置文件的示例如下：

# 看板状态配置
STATUSES="TODO DOING HOLD DONE"

# 每个状态的任务数量限制
LIMIT_TODO=10
LIMIT_DOING=5
LIMIT_HOLD=3
LIMIT_DONE=20

# 终端显示宽度
MAX_LINE_WIDTH=120

# 是否启用颜色
NOCOLOR=0

# 是否启用特殊字符
PLAIN=0

通过编辑该配置文件，用户可以根据自己的需求自定义看板的行为和显示方式。

kanban.bash commandline asciii kanban board for minimalist productivity hackers & managers (csv-based) #scriptable #nestable #statistics #singlefile #shellscript 项目地址: https://gitcode.com/gh_mirrors/ka/kanban.bash