viban-cli 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +120 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
# viban
|
|
2
|
+
|
|
3
|
+
A Kanban-style board in your CLI, powered by local SQLite.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g viban-cli
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Quick Start
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
# Initialize the database (creates a default project)
|
|
15
|
+
viban init
|
|
16
|
+
|
|
17
|
+
# View the Kanban board
|
|
18
|
+
viban board
|
|
19
|
+
|
|
20
|
+
# Add a task
|
|
21
|
+
viban tasks:new -n "My first task"
|
|
22
|
+
|
|
23
|
+
# Move a task to in-progress
|
|
24
|
+
viban tasks:move <task-id> in_progress
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Commands
|
|
28
|
+
|
|
29
|
+
### `viban init`
|
|
30
|
+
|
|
31
|
+
Initialize the local SQLite database and create the default project. Run this once before using other commands.
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
viban init
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### `viban board`
|
|
38
|
+
|
|
39
|
+
Display the Kanban board with all tasks organized by status.
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
viban board
|
|
43
|
+
viban board -p myproject # Filter to a specific project
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Tasks
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
# List all tasks
|
|
50
|
+
viban tasks:list
|
|
51
|
+
viban tasks:list -p myproject # Filter by project
|
|
52
|
+
viban tasks:list -s in_progress # Filter by status
|
|
53
|
+
|
|
54
|
+
# Create a task
|
|
55
|
+
viban tasks:new -n "Fix login bug"
|
|
56
|
+
viban tasks:new -n "Add dark mode" -d "Support prefers-color-scheme" -p myproject -s todo
|
|
57
|
+
|
|
58
|
+
# Show task details
|
|
59
|
+
viban tasks:show <task-id>
|
|
60
|
+
|
|
61
|
+
# Update a task
|
|
62
|
+
viban tasks:update <task-id> -n "New name"
|
|
63
|
+
viban tasks:update <task-id> -s done
|
|
64
|
+
viban tasks:update <task-id> -p otherproject
|
|
65
|
+
|
|
66
|
+
# Move a task to a new status (shorthand)
|
|
67
|
+
viban tasks:move <task-id> <status>
|
|
68
|
+
|
|
69
|
+
# Delete a task
|
|
70
|
+
viban tasks:delete <task-id>
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Projects
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
# List all projects
|
|
77
|
+
viban projects:list
|
|
78
|
+
|
|
79
|
+
# Create a project
|
|
80
|
+
viban projects:new myproject
|
|
81
|
+
|
|
82
|
+
# Delete a project and all its tasks
|
|
83
|
+
viban projects:delete myproject
|
|
84
|
+
viban projects:delete myproject -f # Skip confirmation prompt
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## Flags Reference
|
|
88
|
+
|
|
89
|
+
| Command | Flag | Description |
|
|
90
|
+
|---|---|---|
|
|
91
|
+
| `board` | `-p, --project <project>` | Filter to a specific project |
|
|
92
|
+
| `tasks:list` | `-p, --project <project>` | Filter by project name or ID |
|
|
93
|
+
| `tasks:list` | `-s, --status <status>` | Filter by status |
|
|
94
|
+
| `tasks:new` | `-n, --name <name>` | Task name/title |
|
|
95
|
+
| `tasks:new` | `-d, --description <desc>` | Task description |
|
|
96
|
+
| `tasks:new` | `-p, --project <project>` | Project name or ID (default: "default") |
|
|
97
|
+
| `tasks:new` | `-s, --status <status>` | Initial status (default: ready) |
|
|
98
|
+
| `tasks:update` | `-n, --name <name>` | New name |
|
|
99
|
+
| `tasks:update` | `-d, --description <desc>` | New description |
|
|
100
|
+
| `tasks:update` | `-s, --status <status>` | New status |
|
|
101
|
+
| `tasks:update` | `-p, --project <project>` | Move to a different project |
|
|
102
|
+
| `projects:delete` | `-f, --force` | Skip confirmation prompt |
|
|
103
|
+
|
|
104
|
+
## Task Statuses
|
|
105
|
+
|
|
106
|
+
| Status | Aliases |
|
|
107
|
+
|--------------|--------------------------------|
|
|
108
|
+
| `ready` | |
|
|
109
|
+
| `todo` | |
|
|
110
|
+
| `in_progress`| `wip`, `inprogress`, `in progress` |
|
|
111
|
+
| `in_review` | `review`, `inreview`, `in review` |
|
|
112
|
+
| `done` | |
|
|
113
|
+
|
|
114
|
+
## Data Storage
|
|
115
|
+
|
|
116
|
+
viban stores all data in a local SQLite database at `~/.viban/db.sqlite`. You can override this with the `VIBAN_DB` environment variable.
|
|
117
|
+
|
|
118
|
+
## License
|
|
119
|
+
|
|
120
|
+
MIT
|