kanban-lite 1.2.7 → 1.2.9
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 +98 -0
- package/dist/cli.js +5112 -22054
- package/package.json +33 -2
package/README.md
ADDED
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
# Kanban Lite
|
|
2
|
+
|
|
3
|
+
Kanban Lite is a markdown-first kanban board that works as a **CLI**, **REST API**, **MCP server**, **SDK**, **standalone web app**, and **VS Code extension**.
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/kanban-lite)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
Manage tasks in plain files, keep everything version-controllable, and expose the same board through human and agent-friendly interfaces.
|
|
9
|
+
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
npm install -g kanban-lite
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Quick start
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
# initialize a workspace board
|
|
20
|
+
kl init
|
|
21
|
+
|
|
22
|
+
# create a card
|
|
23
|
+
kl add --title "My first task" --priority high
|
|
24
|
+
|
|
25
|
+
# start the standalone UI
|
|
26
|
+
kl serve
|
|
27
|
+
|
|
28
|
+
# start the MCP server for agent tools
|
|
29
|
+
kl mcp
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## What you get
|
|
33
|
+
|
|
34
|
+
- **Markdown-first storage** by default
|
|
35
|
+
- **Web UI** with drag-and-drop board management
|
|
36
|
+
- **CLI** for automation and local workflows
|
|
37
|
+
- **REST API** for integrations
|
|
38
|
+
- **MCP server** for AI agents
|
|
39
|
+
- **SDK** for embedding Kanban Lite in your own tooling
|
|
40
|
+
- **Multi-board support**, comments, logs, forms, actions, labels, attachments, filters, and webhooks
|
|
41
|
+
|
|
42
|
+
## Common commands
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
# list cards
|
|
46
|
+
kl list
|
|
47
|
+
|
|
48
|
+
# create a card on a specific board
|
|
49
|
+
kl add --board bugs --title "Fix login bug"
|
|
50
|
+
|
|
51
|
+
# move a card
|
|
52
|
+
kl move fix-login-bug in-progress
|
|
53
|
+
|
|
54
|
+
# show current storage/provider status
|
|
55
|
+
kl storage status
|
|
56
|
+
|
|
57
|
+
# run the MCP server
|
|
58
|
+
kanban-mcp --dir .kanban
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
## SDK
|
|
62
|
+
|
|
63
|
+
```ts
|
|
64
|
+
import { KanbanSDK } from 'kanban-lite/sdk'
|
|
65
|
+
|
|
66
|
+
const sdk = new KanbanSDK('/path/to/.kanban')
|
|
67
|
+
|
|
68
|
+
const cards = await sdk.listCards()
|
|
69
|
+
const card = await sdk.createCard({
|
|
70
|
+
content: '# Investigate outage',
|
|
71
|
+
status: 'todo',
|
|
72
|
+
priority: 'high',
|
|
73
|
+
})
|
|
74
|
+
|
|
75
|
+
await sdk.moveCard(card.id, 'in-progress')
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Docs
|
|
79
|
+
|
|
80
|
+
- Docs site: <https://borgius.github.io/kanban-lite/>
|
|
81
|
+
- Quick start: <https://borgius.github.io/kanban-lite/docs/quick-start/>
|
|
82
|
+
- Repository: <https://github.com/borgius/kanban-lite>
|
|
83
|
+
- Full README: <https://github.com/borgius/kanban-lite#readme>
|
|
84
|
+
- SDK docs: <https://github.com/borgius/kanban-lite/blob/main/docs/sdk.md>
|
|
85
|
+
- API docs: <https://github.com/borgius/kanban-lite/blob/main/docs/api.md>
|
|
86
|
+
- Webhooks docs: <https://github.com/borgius/kanban-lite/blob/main/docs/webhooks.md>
|
|
87
|
+
- Forms docs: <https://github.com/borgius/kanban-lite/blob/main/docs/forms.md>
|
|
88
|
+
- Auth docs: <https://github.com/borgius/kanban-lite/blob/main/docs/auth.md>
|
|
89
|
+
|
|
90
|
+
## Notes for npm users
|
|
91
|
+
|
|
92
|
+
The npm package is published from `packages/kanban-lite`, so the npm package page reads documentation from this package-local `README.md`.
|
|
93
|
+
|
|
94
|
+
For the full project documentation, screenshots, examples, and workspace-level guides, start with the docs site above.
|
|
95
|
+
|
|
96
|
+
## License
|
|
97
|
+
|
|
98
|
+
MIT
|