kandown 0.2.2 → 0.3.0
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 +13 -7
- package/bin/kandown.js +172 -11
- package/bin/tui.js +476 -268
- package/dist/index.html +407 -394
- package/package.json +7 -2
- package/templates/README.md +8 -7
- package/templates/AGENT_KANDOWN_COMPACT.md +0 -65
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "kandown",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
4
4
|
"description": "File-based Kanban engine backed by Markdown. Zero backend, AI-agent friendly.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -66,9 +66,14 @@
|
|
|
66
66
|
"zustand": "^5.0.0"
|
|
67
67
|
},
|
|
68
68
|
"dependencies": {
|
|
69
|
+
"@radix-ui/react-slot": "1.2.4",
|
|
69
70
|
"chokidar": "^4.0.0",
|
|
71
|
+
"class-variance-authority": "0.7.1",
|
|
72
|
+
"clsx": "2.1.1",
|
|
73
|
+
"lucide-react": "1.8.0",
|
|
70
74
|
"react-devtools-core": ">=6.1.2",
|
|
71
|
-
"signal-exit": "^3.0.7"
|
|
75
|
+
"signal-exit": "^3.0.7",
|
|
76
|
+
"tailwind-merge": "3.5.0"
|
|
72
77
|
},
|
|
73
78
|
"engines": {
|
|
74
79
|
"node": ">=18"
|
package/templates/README.md
CHANGED
|
@@ -1,23 +1,23 @@
|
|
|
1
1
|
# .kandown/
|
|
2
2
|
|
|
3
|
-
File-based kanban for this project. Zero backend, plain markdown on disk.
|
|
3
|
+
File-based kanban for this project. Zero install, zero backend, plain markdown on disk.
|
|
4
4
|
|
|
5
5
|
## Usage
|
|
6
6
|
|
|
7
7
|
1. Open `kandown.html` in Chrome, Edge, Brave or Opera (File System Access API required)
|
|
8
|
-
2. Click **Select folder** and pick
|
|
9
|
-
3.
|
|
8
|
+
2. Click **Select folder** and pick this `.kandown/` directory, then grant read/write permission
|
|
9
|
+
3. That's it
|
|
10
10
|
|
|
11
|
-
The app remembers the last 10 projects you've opened.
|
|
11
|
+
The app remembers the last 10 projects you've opened — no need to re-select the folder each time.
|
|
12
12
|
|
|
13
13
|
## Structure
|
|
14
14
|
|
|
15
15
|
```
|
|
16
16
|
.kandown/
|
|
17
17
|
├── tasks/
|
|
18
|
-
│ ├── t1.md ← full task details
|
|
18
|
+
│ ├── t1.md ← full task details
|
|
19
19
|
│ └── ...
|
|
20
|
-
├── kandown.html
|
|
20
|
+
├── kandown.html ← the engine (single file, no dependencies)
|
|
21
21
|
├── kandown.json ← project preferences, columns, appearance, optional fields
|
|
22
22
|
├── AGENT.md ← AI coding agent conventions
|
|
23
23
|
└── README.md ← this file
|
|
@@ -40,9 +40,10 @@ See `AGENT.md`. The key convention: each task file is its own source of truth. M
|
|
|
40
40
|
| Key | Action |
|
|
41
41
|
|---|---|
|
|
42
42
|
| `⌘K` / `Ctrl+K` | Command palette |
|
|
43
|
-
| `⌘1` /
|
|
43
|
+
| `⌘1` / `Ctrl+2` | Board / list view |
|
|
44
44
|
| `N` | New task |
|
|
45
45
|
| `R` | Reload |
|
|
46
46
|
| `/` | Focus search |
|
|
47
47
|
| `Esc` | Close drawer / palette |
|
|
48
48
|
| `⌘S` | Save current task |
|
|
49
|
+
| `⌘⌫` | Delete task (with confirmation) |
|
|
@@ -1,65 +0,0 @@
|
|
|
1
|
-
# Kandown — AI Agent Rules
|
|
2
|
-
|
|
3
|
-
You are working on a task managed by **Kandown**, a file-based Kanban system.
|
|
4
|
-
Complete the task and keep its task file updated as you work.
|
|
5
|
-
|
|
6
|
-
## File Locations
|
|
7
|
-
|
|
8
|
-
```
|
|
9
|
-
.kandown/
|
|
10
|
-
├── tasks/<id>.md ← full task details and source of truth
|
|
11
|
-
└── kandown.json ← project config, including board.columns
|
|
12
|
-
```
|
|
13
|
-
|
|
14
|
-
## When You Start
|
|
15
|
-
|
|
16
|
-
1. Open `.kandown/tasks/<id>.md`.
|
|
17
|
-
2. Set frontmatter `status: In Progress`.
|
|
18
|
-
3. Read the full task context before editing code.
|
|
19
|
-
|
|
20
|
-
## While Working
|
|
21
|
-
|
|
22
|
-
After completing each subtask:
|
|
23
|
-
1. Check it off in the task file: `- [ ]` → `- [x]`.
|
|
24
|
-
2. Add a report line below it when useful: ` report: What you did.`
|
|
25
|
-
|
|
26
|
-
Example:
|
|
27
|
-
|
|
28
|
-
```markdown
|
|
29
|
-
- [x] Create auth module
|
|
30
|
-
report: Created src/auth.ts with JWT validation. Added /api/auth route.
|
|
31
|
-
- [ ] Add tests
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
## When You Finish
|
|
35
|
-
|
|
36
|
-
1. Write the `report:` field in the task frontmatter (markdown supported, displayed in UI report panel):
|
|
37
|
-
|
|
38
|
-
```yaml
|
|
39
|
-
---
|
|
40
|
-
id: t19
|
|
41
|
-
title: My task
|
|
42
|
-
status: Done
|
|
43
|
-
report: |
|
|
44
|
-
## Changes
|
|
45
|
-
- Created src/auth.ts (JWT, RS256)
|
|
46
|
-
- Added /api/auth/login endpoint
|
|
47
|
-
## Files
|
|
48
|
-
- src/auth.ts (new)
|
|
49
|
-
## Decisions
|
|
50
|
-
- Used RS256 for better key rotation support
|
|
51
|
-
---
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
2. Set frontmatter `status: Done`.
|
|
55
|
-
3. Leave all subtasks checked if the task is complete.
|
|
56
|
-
|
|
57
|
-
**Subtask reports**: Write per-step reports in the `[REPORT]` section under each subtask in the body, not in separate sections.
|
|
58
|
-
|
|
59
|
-
## Rules
|
|
60
|
-
|
|
61
|
-
- The task file is the source of truth.
|
|
62
|
-
- Do not maintain a separate board index.
|
|
63
|
-
- If a task has no `status`, treat it as `Backlog`.
|
|
64
|
-
- Board columns are configured in `.kandown/kandown.json` at `board.columns`.
|
|
65
|
-
- If you notice unrelated issues, create a separate task file instead of fixing inline.
|