KanOrg: kanban organizer

KanOrg allows you easily organize all your tasks from the terminal.

This commandline application will help you save everything important and will let you take the control of your work (and not the other way arround).

Table of contents:

1. Roadmap :scroll:
2. Installation :floppy_disk:
3. Before running anything, some basics :warning:
4. CLI :dvd:
   1. Create
   2. Show
   3. Add
   4. Relocate
   5. Edit
   6. Delete
5. Running tests :bomb:
6. License :bookmark:

Roadmap :scroll:

Missing commandline features:

• Move a task from one workflow to another
• Edit a task
• Delete a task

Other features:

• Add due date and priority tags (maybe with automatic colours)
• Add a command to list/remove/show archived tasks
• Add a command to show a task without editing

If you want to request a new feature, create an issue!

Installation :floppy_disk:

To install the package $HOME/.cargo/bin run:

cargo install --path .

Before running anything, some basics :warning:

This CLI is based on a well defined directory structure. It is based on a main directory .kanorg.d, the configuration file (.kanorg.d/config), and the active and archived task directories (.kanorg.d/active.d and .kanorg.d/archive.d respectively).

Take a look to the "examples" directory where all the files mentioned above can be found. By default, when you create a new KanOrg config directory, you will have empty active and archive directories with empty lists of tasks in the config file.

CLI :dvd:

In this section some uses of each command will be mentioned. If you want to see more indepth information about the library, you can run:

cargo doc --document-private-items --no-deps --open

Create

To create a new configuration environment you can run:

ko create [<target directory>]

By default, if you don't pass the <target directory> argument, it will create the configuration in the current directory.

Show

To show the active tasks you can run:

ko show [<workflow name>]

If no workflow is specified you will get something like:

|          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.

You can also specify some workflow to list all the tasks in it. It will show something like:

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

Add

You can add a new task with:

ko add <task title> [<workflow name>]

If the <workflow name> is not specified, the new task will be created in backlog.

Relocate

Not implemented yet

Edit

Not implemented yet

Delete

Not implemented yet

Running tests :bomb:

In order to run all available tests:

cargo test

License :bookmark:

The source code is released under the MIT license.