8 个不稳定版本 (3 个破坏性更新)

0.5.0 2021 年 5 月 20 日
0.4.0 2021 年 5 月 2 日
0.3.1 2021 年 5 月 2 日
0.3.0 2021 年 5 月 2 日
0.2.0 2021 年 4 月 27 日

#2636 in 命令行工具

MIT 许可证

64KB
999 代码行

KanOrg: 看板组织者

Crates.io docs.rs Pipeline

KanOrg 允许您轻松地从终端组织所有任务。

此命令行应用程序将帮助您保存所有重要信息,并让您掌握工作控制权(而不是相反)。


目录

  1. 安装 💾
  2. 在运行任何内容之前,一些基本注意事项 ⚠️
  3. CLI 📀
    1. 创建
    2. 显示
    3. 添加
    4. 移动
    5. 编辑
    6. 删除
  4. 运行测试 💣
  5. 许可证 🔖

安装 💾

要将软件包安装到 $HOME/.cargo/bin,请运行

cargo install kanorg

在运行任何内容之前,一些基本注意事项 ⚠️

此 CLI 基于定义良好的目录结构。它基于主目录 .kanorg.d、配置文件 (.kanorg.d/config),以及活动任务和归档任务目录 (.kanorg.d/active.d.kanorg.d/archive.d 分别)。

请查看 "examples" 目录,其中可以找到上述所有文件。默认情况下,当您创建新的 KanOrg 配置目录时,您将在配置文件中有空的列表和空的活动目录和归档目录。

CLI 📀

在本节中,将提及每个命令的一些用例。您还可以查看库的 API 文档。如果您想查看私有结构和方法的文档,您需要在克隆存储库后运行以下命令

cargo doc --document-private-items --open

创建

要创建新的配置环境,请运行

ko c[reate] [<target directory>]

默认情况下,如果不传递 <目标目录> 参数,它将在当前目录中创建配置。

显示

要显示活动任务,请运行

ko s[how] [<task | workflow>]

如果没有指定工作流程或任务,您将得到类似以下内容

$ ko show

|          TODO           |          DOING          |          DONE           |
|-------------------------|-------------------------|-------------------------|
|  18 This is the task 18 |  14 This is the task 14 |  12 This is the task 12 |
|  17 This is the task 17 |  13 This is the task 13 |  11 This is the task 11 |
|  16 This is the task 16 |                         |  10 This is the task 10 |
|  15 This is the task 15 |                         |   9 This is the task 9  |
|                         |                         |   8 This is the task 8  |

BACKLOG
  25 This is the task 25 sample title
  24 This is the task 24 sample title
  23 This is the task 23 sample title
  22 This is the task 22 sample title
  21 This is the task 21 sample title
WARNING: The backlog has been trimmed. Run `ko show backlog` to see all the backlog tasks.

您还可以指定一些工作流来列出其中的所有任务。它会显示类似的内容:

$ ko show backlog

BACKLOG
  25 This is the task 25 sample title
  24 This is the task 24 sample title
  23 This is the task 23 sample title
  22 This is the task 22 sample title
  21 This is the task 21 sample title
  20 This is the task 20 sample title
  19 This is the task 19 sample title

另一方面,如果您传递一个任务的ID,它将显示其内容

$ ko show 17

# This is the task 17 sample title

some description from the task 17

添加

您可以使用以下方式添加一个新任务:

ko a[dd] [-e] <task title> [<workflow name>]

如果没有指定 <工作流名称>,新任务将在 待办事项 中创建。如果您想在创建后就地编辑任务,请使用标志 -e

移动

为了将任务从一个工作流移动到另一个工作流

ko m[ove] <task ID> [<workflow name>]

如果没有指定 <工作流名称>,它将被移动到待办事项中。

编辑

您可以编辑任何正在运行的活动任务

ko e[dit] <task ID>

它将使用您的默认编辑器($EDITOR环境变量)打开任务文件。如果没有定义编辑器,它将尝试使用 vi

删除

删除一个活动任务

ko d[elete] <task ID>

运行测试 💣

为了运行包测试

cargo test [(--lib | --tests integration --features integration)]

许可证 🔖

源代码在MIT许可证下发布。

依赖项

~1–10MB
~80K SLoC