@ashikahmad/kanbanmd 0.0.0-stage → 2.0.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.
@@ -0,0 +1,77 @@
1
+ ---
2
+ name: markdown-task-manager
3
+ description: Use when managing tasks. The system is a Kanban task manager on local Markdown files (`kanban.md`, `archive.md`, optionally `backlog.md`) that a human edits in the kanbanmd.html web app at the same time. Prefer the Kanban MCP tools or the `kanbanmd` CLI; fall back to the file format described here.
4
+ ---
5
+
6
+ # 📋 Kanban.md Skill
7
+
8
+ Full guide: `AI_WORKFLOW.md` in the project root. This skill is the short version.
9
+
10
+ ## When to use it
11
+
12
+ - Create tasks to document work to be done, plan features, track progress
13
+ - Report status ("where are we?"), archive on request
14
+
15
+ A human is using the board in the browser while you work. Make small, targeted edits.
16
+
17
+ ## 1. Tools first
18
+
19
+ If the **Kanban MCP server** is connected (`get_board`, `get_task`, `save_task`, `move_task`, …) or you can run `kanbanmd`, use it. Do **not** read or hand-edit `kanban.md` then: the tools return a few hundred tokens instead of the whole file, validate every change, and merge with the human's concurrent edits.
20
+
21
+ | Intent | Tool |
22
+ |---|---|
23
+ | What is in a column / who has what / what is overdue | `get_board` (filters), `get_board_stats` |
24
+ | One task in full | `get_task` |
25
+ | Valid columns, priorities, users | `get_config` |
26
+ | Create / change a task | `save_task` (no `id` creates) |
27
+ | Change column | `move_task` |
28
+ | Subtasks, notes | `subtask`, `add_note` |
29
+ | Archive / restore / delete | `archive_tasks`, `restore_task`, `delete_task` |
30
+ | Archive or backlog file contents | `get_board` with `archived: true` / `backlog: true` |
31
+
32
+ Rules: pass the task's `etag` as `ifMatch` when changing something you read earlier (a `conflict` means re-read and redo); use `dryRun` to preview; errors list the valid choices; `needs_migration` means tell the user to open the board in the browser or run `kanbanmd migrate`; if `get_board_stats` returns `housekeeping` suggestions, **tell the user, never archive unasked**; `sort_tasks` rewrites a file-wide order, so never call it unprompted.
33
+
34
+ CLI equivalents: `kanbanmd board --status review`, `task TASK-014`, `move TASK-014 done`, `create --title … --status …`, `note`, `toggle`, `archive`, `stats`, `housekeeping`. Add `--dry-run` to preview.
35
+
36
+ ## 2. Task format (only if you edit files yourself): v3, one field per line, each ending in two spaces (Markdown hard break; lines without them still parse)
37
+
38
+ ```markdown
39
+ ### TASK-XXX | Task title
40
+ **Status**: <column-id>
41
+ **Priority**: High
42
+ **Category**: Backend
43
+ **Assigned**: @user1, @user2
44
+ **Created**: YYYY-MM-DD
45
+ **Due**: YYYY-MM-DD
46
+ **Tags**: #tag1 #tag2
47
+
48
+ Free text description. **NO `##` or `###` headings allowed**.
49
+
50
+ **Subtasks**:
51
+ - [ ] First subtask
52
+ - [x] Completed subtask
53
+
54
+ **Notes**:
55
+ **Result**:
56
+ What was done.
57
+ ```
58
+
59
+ Required: the `### TASK-XXX |` header and `**Status**:` (a column id). Everything else is optional and independent; leave empty fields out. Optional `**Order**: n` is a manual card order: leave it alone. Forbidden: `##`/`###` headings inside a task; `**Subtasks**`/`**Notes**` without the colon.
60
+
61
+ - **Move a task:** edit its one `**Status**:` line. Never cut and paste the block.
62
+ - **New task:** append the block at the end of `kanban.md` and bump `<!-- Config: Last Task ID: N -->`.
63
+ - If the Configuration has `**Backlog file**: backlog.md (backlog)`, tasks of that column live in `backlog.md`; a status change moves them. Do not manage the file.
64
+
65
+ ## 3. Workflow
66
+
67
+ 1. **New request:** create the task (status = first column), break into subtasks if needed.
68
+ 2. **Start:** move to in-progress, set `Started`, tick subtasks as you go.
69
+ 3. **Finish:** move to done, set `Finished`, document `**Result**:`, `**Modified files**:`, `**Technical decisions**:`, `**Tests performed**:` in `**Notes**:`.
70
+ 4. **Archiving:** never automatic. Finished tasks stay in the done column until the user asks.
71
+ 5. Reference tasks in commits (`TASK-XXX`).
72
+
73
+ ## Golden rules
74
+
75
+ - Create the task before coding; progress in real time; document the result.
76
+ - Use the tools when you have them; otherwise the strict format.
77
+ - Never archive unasked; never rewrite a whole file when a one-line edit will do.
package/LICENSE ADDED
@@ -0,0 +1,373 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ 1.5. "Incompatible With Secondary Licenses"
25
+ means
26
+
27
+ (a) that the initial Contributor has attached the notice described
28
+ in Exhibit B to the Covered Software; or
29
+
30
+ (b) that the Covered Software was made available under the terms of
31
+ version 1.1 or earlier of the License, but not also under the
32
+ terms of a Secondary License.
33
+
34
+ 1.6. "Executable Form"
35
+ means any form of the work other than Source Code Form.
36
+
37
+ 1.7. "Larger Work"
38
+ means a work that combines Covered Software with other material, in
39
+ a separate file or files, that is not Covered Software.
40
+
41
+ 1.8. "License"
42
+ means this document.
43
+
44
+ 1.9. "Licensable"
45
+ means having the right to grant, to the maximum extent possible,
46
+ whether at the time of the initial grant or subsequently, any and
47
+ all of the rights conveyed by this License.
48
+
49
+ 1.10. "Modifications"
50
+ means any of the following:
51
+
52
+ (a) any file in Source Code Form that results from an addition to,
53
+ deletion from, or modification of the contents of Covered
54
+ Software; or
55
+
56
+ (b) any new file in Source Code Form that contains any Covered
57
+ Software.
58
+
59
+ 1.11. "Patent Claims" of a Contributor
60
+ means any patent claim(s), including without limitation, method,
61
+ process, and apparatus claims, in any patent Licensable by such
62
+ Contributor that would be infringed, but for the grant of the
63
+ License, by the making, using, selling, offering for sale, having
64
+ made, import, or transfer of either its Contributions or its
65
+ Contributor Version.
66
+
67
+ 1.12. "Secondary License"
68
+ means either the GNU General Public License, Version 2.0, the GNU
69
+ Lesser General Public License, Version 2.1, the GNU Affero General
70
+ Public License, Version 3.0, or any later versions of those
71
+ licenses.
72
+
73
+ 1.13. "Source Code Form"
74
+ means the form of the work preferred for making modifications.
75
+
76
+ 1.14. "You" (or "Your")
77
+ means an individual or a legal entity exercising rights under this
78
+ License. For legal entities, "You" includes any entity that
79
+ controls, is controlled by, or is under common control with You. For
80
+ purposes of this definition, "control" means (a) the power, direct
81
+ or indirect, to cause the direction or management of such entity,
82
+ whether by contract or otherwise, or (b) ownership of more than
83
+ fifty percent (50%) of the outstanding shares or beneficial
84
+ ownership of such entity.
85
+
86
+ 2. License Grants and Conditions
87
+ --------------------------------
88
+
89
+ 2.1. Grants
90
+
91
+ Each Contributor hereby grants You a world-wide, royalty-free,
92
+ non-exclusive license:
93
+
94
+ (a) under intellectual property rights (other than patent or trademark)
95
+ Licensable by such Contributor to use, reproduce, make available,
96
+ modify, display, perform, distribute, and otherwise exploit its
97
+ Contributions, either on an unmodified basis, with Modifications, or
98
+ as part of a Larger Work; and
99
+
100
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
101
+ for sale, have made, import, and otherwise transfer either its
102
+ Contributions or its Contributor Version.
103
+
104
+ 2.2. Effective Date
105
+
106
+ The licenses granted in Section 2.1 with respect to any Contribution
107
+ become effective for each Contribution on the date the Contributor first
108
+ distributes such Contribution.
109
+
110
+ 2.3. Limitations on Grant Scope
111
+
112
+ The licenses granted in this Section 2 are the only rights granted under
113
+ this License. No additional rights or licenses will be implied from the
114
+ distribution or licensing of Covered Software under this License.
115
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
116
+ Contributor:
117
+
118
+ (a) for any code that a Contributor has removed from Covered Software;
119
+ or
120
+
121
+ (b) for infringements caused by: (i) Your and any other third party's
122
+ modifications of Covered Software, or (ii) the combination of its
123
+ Contributions with other software (except as part of its Contributor
124
+ Version); or
125
+
126
+ (c) under Patent Claims infringed by Covered Software in the absence of
127
+ its Contributions.
128
+
129
+ This License does not grant any rights in the trademarks, service marks,
130
+ or logos of any Contributor (except as may be necessary to comply with
131
+ the notice requirements in Section 3.4).
132
+
133
+ 2.4. Subsequent Licenses
134
+
135
+ No Contributor makes additional grants as a result of Your choice to
136
+ distribute the Covered Software under a subsequent version of this
137
+ License (see Section 10.2) or under the terms of a Secondary License (if
138
+ permitted under the terms of Section 3.3).
139
+
140
+ 2.5. Representation
141
+
142
+ Each Contributor represents that the Contributor believes its
143
+ Contributions are its original creation(s) or it has sufficient rights
144
+ to grant the rights to its Contributions conveyed by this License.
145
+
146
+ 2.6. Fair Use
147
+
148
+ This License is not intended to limit any rights You have under
149
+ applicable copyright doctrines of fair use, fair dealing, or other
150
+ equivalents.
151
+
152
+ 2.7. Conditions
153
+
154
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155
+ in Section 2.1.
156
+
157
+ 3. Responsibilities
158
+ -------------------
159
+
160
+ 3.1. Distribution of Source Form
161
+
162
+ All distribution of Covered Software in Source Code Form, including any
163
+ Modifications that You create or to which You contribute, must be under
164
+ the terms of this License. You must inform recipients that the Source
165
+ Code Form of the Covered Software is governed by the terms of this
166
+ License, and how they can obtain a copy of this License. You may not
167
+ attempt to alter or restrict the recipients' rights in the Source Code
168
+ Form.
169
+
170
+ 3.2. Distribution of Executable Form
171
+
172
+ If You distribute Covered Software in Executable Form then:
173
+
174
+ (a) such Covered Software must also be made available in Source Code
175
+ Form, as described in Section 3.1, and You must inform recipients of
176
+ the Executable Form how they can obtain a copy of such Source Code
177
+ Form by reasonable means in a timely manner, at a charge no more
178
+ than the cost of distribution to the recipient; and
179
+
180
+ (b) You may distribute such Executable Form under the terms of this
181
+ License, or sublicense it under different terms, provided that the
182
+ license for the Executable Form does not attempt to limit or alter
183
+ the recipients' rights in the Source Code Form under this License.
184
+
185
+ 3.3. Distribution of a Larger Work
186
+
187
+ You may create and distribute a Larger Work under terms of Your choice,
188
+ provided that You also comply with the requirements of this License for
189
+ the Covered Software. If the Larger Work is a combination of Covered
190
+ Software with a work governed by one or more Secondary Licenses, and the
191
+ Covered Software is not Incompatible With Secondary Licenses, this
192
+ License permits You to additionally distribute such Covered Software
193
+ under the terms of such Secondary License(s), so that the recipient of
194
+ the Larger Work may, at their option, further distribute the Covered
195
+ Software under the terms of either this License or such Secondary
196
+ License(s).
197
+
198
+ 3.4. Notices
199
+
200
+ You may not remove or alter the substance of any license notices
201
+ (including copyright notices, patent notices, disclaimers of warranty,
202
+ or limitations of liability) contained within the Source Code Form of
203
+ the Covered Software, except that You may alter any license notices to
204
+ the extent required to remedy known factual inaccuracies.
205
+
206
+ 3.5. Application of Additional Terms
207
+
208
+ You may choose to offer, and to charge a fee for, warranty, support,
209
+ indemnity or liability obligations to one or more recipients of Covered
210
+ Software. However, You may do so only on Your own behalf, and not on
211
+ behalf of any Contributor. You must make it absolutely clear that any
212
+ such warranty, support, indemnity, or liability obligation is offered by
213
+ You alone, and You hereby agree to indemnify every Contributor for any
214
+ liability incurred by such Contributor as a result of warranty, support,
215
+ indemnity or liability terms You offer. You may include additional
216
+ disclaimers of warranty and limitations of liability specific to any
217
+ jurisdiction.
218
+
219
+ 4. Inability to Comply Due to Statute or Regulation
220
+ ---------------------------------------------------
221
+
222
+ If it is impossible for You to comply with any of the terms of this
223
+ License with respect to some or all of the Covered Software due to
224
+ statute, judicial order, or regulation then You must: (a) comply with
225
+ the terms of this License to the maximum extent possible; and (b)
226
+ describe the limitations and the code they affect. Such description must
227
+ be placed in a text file included with all distributions of the Covered
228
+ Software under this License. Except to the extent prohibited by statute
229
+ or regulation, such description must be sufficiently detailed for a
230
+ recipient of ordinary skill to be able to understand it.
231
+
232
+ 5. Termination
233
+ --------------
234
+
235
+ 5.1. The rights granted under this License will terminate automatically
236
+ if You fail to comply with any of its terms. However, if You become
237
+ compliant, then the rights granted under this License from a particular
238
+ Contributor are reinstated (a) provisionally, unless and until such
239
+ Contributor explicitly and finally terminates Your grants, and (b) on an
240
+ ongoing basis, if such Contributor fails to notify You of the
241
+ non-compliance by some reasonable means prior to 60 days after You have
242
+ come back into compliance. Moreover, Your grants from a particular
243
+ Contributor are reinstated on an ongoing basis if such Contributor
244
+ notifies You of the non-compliance by some reasonable means, this is the
245
+ first time You have received notice of non-compliance with this License
246
+ from such Contributor, and You become compliant prior to 30 days after
247
+ Your receipt of the notice.
248
+
249
+ 5.2. If You initiate litigation against any entity by asserting a patent
250
+ infringement claim (excluding declaratory judgment actions,
251
+ counter-claims, and cross-claims) alleging that a Contributor Version
252
+ directly or indirectly infringes any patent, then the rights granted to
253
+ You by any and all Contributors for the Covered Software under Section
254
+ 2.1 of this License shall terminate.
255
+
256
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257
+ end user license agreements (excluding distributors and resellers) which
258
+ have been validly granted by You or Your distributors under this License
259
+ prior to termination shall survive termination.
260
+
261
+ ************************************************************************
262
+ * *
263
+ * 6. Disclaimer of Warranty *
264
+ * ------------------------- *
265
+ * *
266
+ * Covered Software is provided under this License on an "as is" *
267
+ * basis, without warranty of any kind, either expressed, implied, or *
268
+ * statutory, including, without limitation, warranties that the *
269
+ * Covered Software is free of defects, merchantable, fit for a *
270
+ * particular purpose or non-infringing. The entire risk as to the *
271
+ * quality and performance of the Covered Software is with You. *
272
+ * Should any Covered Software prove defective in any respect, You *
273
+ * (not any Contributor) assume the cost of any necessary servicing, *
274
+ * repair, or correction. This disclaimer of warranty constitutes an *
275
+ * essential part of this License. No use of any Covered Software is *
276
+ * authorized under this License except under this disclaimer. *
277
+ * *
278
+ ************************************************************************
279
+
280
+ ************************************************************************
281
+ * *
282
+ * 7. Limitation of Liability *
283
+ * -------------------------- *
284
+ * *
285
+ * Under no circumstances and under no legal theory, whether tort *
286
+ * (including negligence), contract, or otherwise, shall any *
287
+ * Contributor, or anyone who distributes Covered Software as *
288
+ * permitted above, be liable to You for any direct, indirect, *
289
+ * special, incidental, or consequential damages of any character *
290
+ * including, without limitation, damages for lost profits, loss of *
291
+ * goodwill, work stoppage, computer failure or malfunction, or any *
292
+ * and all other commercial damages or losses, even if such party *
293
+ * shall have been informed of the possibility of such damages. This *
294
+ * limitation of liability shall not apply to liability for death or *
295
+ * personal injury resulting from such party's negligence to the *
296
+ * extent applicable law prohibits such limitation. Some *
297
+ * jurisdictions do not allow the exclusion or limitation of *
298
+ * incidental or consequential damages, so this exclusion and *
299
+ * limitation may not apply to You. *
300
+ * *
301
+ ************************************************************************
302
+
303
+ 8. Litigation
304
+ -------------
305
+
306
+ Any litigation relating to this License may be brought only in the
307
+ courts of a jurisdiction where the defendant maintains its principal
308
+ place of business and such litigation shall be governed by laws of that
309
+ jurisdiction, without reference to its conflict-of-law provisions.
310
+ Nothing in this Section shall prevent a party's ability to bring
311
+ cross-claims or counter-claims.
312
+
313
+ 9. Miscellaneous
314
+ ----------------
315
+
316
+ This License represents the complete agreement concerning the subject
317
+ matter hereof. If any provision of this License is held to be
318
+ unenforceable, such provision shall be reformed only to the extent
319
+ necessary to make it enforceable. Any law or regulation which provides
320
+ that the language of a contract shall be construed against the drafter
321
+ shall not be used to construe this License against a Contributor.
322
+
323
+ 10. Versions of the License
324
+ ---------------------------
325
+
326
+ 10.1. New Versions
327
+
328
+ Mozilla Foundation is the license steward. Except as provided in Section
329
+ 10.3, no one other than the license steward has the right to modify or
330
+ publish new versions of this License. Each version will be given a
331
+ distinguishing version number.
332
+
333
+ 10.2. Effect of New Versions
334
+
335
+ You may distribute the Covered Software under the terms of the version
336
+ of the License under which You originally received the Covered Software,
337
+ or under the terms of any subsequent version published by the license
338
+ steward.
339
+
340
+ 10.3. Modified Versions
341
+
342
+ If you create software not governed by this License, and you want to
343
+ create a new license for such software, you may create and use a
344
+ modified version of this License if you rename the license and remove
345
+ any references to the name of the license steward (except to note that
346
+ such modified license differs from this License).
347
+
348
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
349
+ Licenses
350
+
351
+ If You choose to distribute Source Code Form that is Incompatible With
352
+ Secondary Licenses under the terms of this version of the License, the
353
+ notice described in Exhibit B of this License must be attached.
354
+
355
+ Exhibit A - Source Code Form License Notice
356
+ -------------------------------------------
357
+
358
+ This Source Code Form is subject to the terms of the Mozilla Public
359
+ License, v. 2.0. If a copy of the MPL was not distributed with this
360
+ file, You can obtain one at http://mozilla.org/MPL/2.0/.
361
+
362
+ If it is not possible or desirable to put the notice in a particular
363
+ file, then You may include the notice in a location (such as a LICENSE
364
+ file in a relevant directory) where a recipient would be likely to look
365
+ for such a notice.
366
+
367
+ You may add additional accurate notices of copyright ownership.
368
+
369
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
370
+ ---------------------------------------------------------
371
+
372
+ This Source Code Form is "Incompatible With Secondary Licenses", as
373
+ defined by the Mozilla Public License, v. 2.0.
package/README.md CHANGED
@@ -1,3 +1,78 @@
1
- # Temporary Holding Version
1
+ <p align="center"><img src="docs/images/logo.svg" width="96" alt="Kanban.md logo"></p>
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ <h1 align="center">Kanban.md</h1>
4
+
5
+ <p align="center"><strong>A Kanban board that lives in plain Markdown files, shared by you in the browser and by AI agents on the command line.</strong></p>
6
+
7
+ <p align="center"><a href="https://ashikahmad.github.io/Kanban.md/app/">Open the app</a> · <a href="https://ashikahmad.github.io/Kanban.md/">Website</a> · <a href="./board/kanban.md">Project board</a> · <a href="./docs/getting-started.md">Docs</a></p>
8
+
9
+ > **[Version française](./readmeFR.md)** · Kanban.md began as a fork of [ioniks/MarkdownTaskManager](https://github.com/ioniks/MarkdownTaskManager) (MPL-2.0); see [About this fork](docs/about-this-fork.md).
10
+
11
+ ![Kanban.md board](docs/images/app-overview.jpg)
12
+ *The board with the sample data from `docs/demo`.*
13
+
14
+ Kanban.md turns two Markdown files, `kanban.md` and `archive.md`, into an interactive board. The whole app is one HTML file that runs in your browser and reads and writes your folder directly. There is no server, no account and no database, and your tasks stay in files you can read, edit, diff and commit.
15
+
16
+ ## What you get
17
+
18
+ - **Your tasks, as files.** Plain Markdown that works in any editor and displays properly in any Markdown viewer, including GitHub.
19
+ - **Fits in git.** Edits are small line-level patches, so moving a card changes one line and diffs stay readable.
20
+ - **A real board.** Drag-and-drop columns you define, subtasks with progress bars, priorities, tags, categories, assignees, due dates, search, filters, an archive, several projects, light and dark themes, and four interface languages.
21
+ - **Humans and AI at the same time.** A CLI and an MCP server let agents read and change the board safely while you use the browser. Changes show up on both sides within a couple of seconds, and concurrent edits are merged, not overwritten.
22
+ - **Cheap for AI.** An agent reads a few hundred tokens instead of the whole board. A "what is in this column?" question on a 100-task board costs about 1,000 tokens instead of about 20,000.
23
+ - **Private by construction.** Nothing leaves your machine. No telemetry, no CDN, works offline.
24
+ - **Scales up gently.** Housekeeping nudges, an optional separate backlog file, and optional manual card order keep big boards fast.
25
+ - **Shareable.** Copy a task as plain text or as a Markdown block another board can import.
26
+
27
+ ## Where it shines
28
+
29
+ - Developers who want tasks next to their code, in the same repository and the same pull requests.
30
+ - Small teams who share a board through git.
31
+ - Anyone working with AI coding assistants who wants a clear, traceable record of what was asked and done.
32
+ - People who like owning their data and being able to open it in a text editor.
33
+
34
+ ## What it is not for
35
+
36
+ - **Not a hosted service.** No accounts, permissions, notifications or live co-editing. Teams share a board through git or a synced folder.
37
+ - **Not a server or an API.** Agents use the CLI and the MCP server; there is no HTTP API.
38
+ - **Editing needs a Chromium browser.** Opening and editing a folder needs a Chromium-based desktop browser (Chrome, Edge, Opera, Brave). In Firefox and Safari you can open a folder read-only, [view a board from the web](docs/using-the-board.md#viewing-a-board-from-the-web), or edit the real folder by running `kanbanmd serve` in it (needs Node; see [Firefox and Safari](docs/getting-started.md#firefox-and-safari)).
39
+ - **Not a reporting tool.** There are no charts or time tracking yet.
40
+
41
+ ## Install and first run
42
+
43
+ 1. Download [`kanbanmd.html`](kanbanmd.html).
44
+ 2. Open it in Chrome, Edge, Opera or Brave.
45
+ 3. Pick a folder. If it is empty, the app creates `kanban.md` and `archive.md` for you.
46
+
47
+ Want to look around first? Pick the [`docs/demo`](docs/demo) folder for a sample board with dummy tasks.
48
+
49
+ More options, including keeping the app in one shared place and using it across projects, are in [Getting started](docs/getting-started.md).
50
+
51
+ ## Use it with AI agents
52
+
53
+ ```bash
54
+ npx -y @ashikahmad/kanbanmd init # in your project: MCP config, skill and agent instructions
55
+ claude mcp add kanban -- npx -y @ashikahmad/kanbanmd mcp # or just the MCP server
56
+ ```
57
+
58
+ The same operations are available from the shell as the `kanbanmd` CLI (`npx -y @ashikahmad/kanbanmd board --status in-progress`). Copy [`AI_WORKFLOW.md`](AI_WORKFLOW.md) into your project so your assistant knows the rules, and see [Working with AI agents](docs/ai-agents.md) for the tools, the per-assistant templates and the Claude Code skill.
59
+
60
+ ## Documentation
61
+
62
+ | | |
63
+ |---|---|
64
+ | [Getting started](docs/getting-started.md) | Requirements, install options, where to put files, privacy |
65
+ | [Using the board](docs/using-the-board.md) | Tasks, filters, archive, projects, optional features |
66
+ | [Working with AI agents](docs/ai-agents.md) | MCP server, CLI, assistant setup, token costs |
67
+ | [File format](docs/file-format.md) | `kanban.md` and `archive.md`, configuration, migration |
68
+ | [Git and teams](docs/git-and-teams.md) | Sharing a board, conflicts, workflows |
69
+ | [Development](docs/development.md) | Build, test, code layout, contributing, how we run the project |
70
+ | [About this fork](docs/about-this-fork.md) | Where Kanban.md comes from and how it differs from the original |
71
+
72
+ ## What's next
73
+
74
+ The project's own work is tracked on its own board: [`board/kanban.md`](board/kanban.md) shows what is done, in progress, planned, and what ideas we are weighing. You can also [view it in the app](https://ashikahmad.github.io/Kanban.md/app/?board=../board/kanban.md), read-only. Items tagged `#good-first-issue` and `#need-help` are good places to start if you'd like to contribute. Bugs and requests are welcome as GitHub issues.
75
+
76
+ ## License and credit
77
+
78
+ Kanban.md is released under the [Mozilla Public License 2.0](LICENSE). It started as a fork of [ioniks/MarkdownTaskManager](https://github.com/ioniks/MarkdownTaskManager) and keeps its licence and copyright notices. Thanks to the original author and contributors, and to the File System Access API work in Chromium, on which the app relies.
package/cli/init.js ADDED
@@ -0,0 +1,139 @@
1
+ // kanbanmd init: set a project up so AI agents find and use the board tools instead of hand-editing kanban.md.
2
+ // Offline, idempotent and conservative: it creates or merges small files, never overwrites something it did
3
+ // not write (a JSON file it cannot parse, a different "kanban" server entry, an edited skill), and with
4
+ // `dryRun` it changes nothing and only reports. It returns a report; the CLI prints it as JSON.
5
+ import { existsSync, readFileSync, writeFileSync, mkdirSync } from 'node:fs';
6
+ import { join, dirname } from 'node:path';
7
+ import { createInterface } from 'node:readline/promises';
8
+ import { createDefaultBoardContent } from '../core/index.js';
9
+ import { BoardError } from '../core/text.js';
10
+
11
+ const START = '<!-- kanbanmd:start -->', END = '<!-- kanbanmd:end -->';
12
+ const SKILL_REL = '.claude/skills/markdown-task-manager/SKILL.md';
13
+ const SKILL_SOURCE = new URL('../' + SKILL_REL, import.meta.url);
14
+
15
+ // What each agent needs. `mcp`: the project file that registers the server and the key it lives under.
16
+ // `instr`: files that get the instruction block. `skill`: Claude Code skills. `print`: no project-level MCP file
17
+ // exists (the client's config is global), so the entry is only printed.
18
+ export const AGENTS = {
19
+ claude: { label: 'Claude Code', mcp: { file: '.mcp.json', key: 'mcpServers' }, instr: ['CLAUDE.md'], skill: true },
20
+ cursor: { label: 'Cursor', mcp: { file: '.cursor/mcp.json', key: 'mcpServers' }, instr: ['AGENTS.md'] },
21
+ vscode: { label: 'VS Code / GitHub Copilot', mcp: { file: '.vscode/mcp.json', key: 'servers', stdio: true }, instr: ['.github/copilot-instructions.md'] },
22
+ gemini: { label: 'Gemini CLI', mcp: { file: '.gemini/settings.json', key: 'mcpServers' }, instr: ['GEMINI.md'] },
23
+ codex: { label: 'Codex CLI', print: 'codex', instr: ['AGENTS.md'] },
24
+ generic: { label: 'Any other agent (AGENTS.md only)', instr: ['AGENTS.md'] },
25
+ };
26
+ export const AGENT_NAMES = Object.keys(AGENTS);
27
+
28
+ export function parseAgents(value) {
29
+ const names = String(value).split(',').map((s) => s.trim().toLowerCase()).filter(Boolean);
30
+ const out = names.includes('all') ? [...AGENT_NAMES] : names;
31
+ const bad = out.filter((n) => !AGENTS[n]);
32
+ if (bad.length || !out.length) {
33
+ throw new BoardError('usage', `Unknown agent "${bad[0] || value}"`, { hint: `Use --agent ${AGENT_NAMES.join('|')} (comma separated) or all`, valid: AGENT_NAMES });
34
+ }
35
+ return [...new Set(out)];
36
+ }
37
+
38
+ // Ask which agents to set up (numbers, comma separated; Enter picks Claude Code).
39
+ export async function promptAgents(input = process.stdin, output = process.stderr) {
40
+ const rl = createInterface({ input, output });
41
+ try {
42
+ output.write('Which AI agents should be set up?\n');
43
+ AGENT_NAMES.forEach((n, i) => output.write(` ${i + 1}. ${AGENTS[n].label}\n`));
44
+ const answer = (await rl.question('Numbers, comma separated, or "all" [1]: ')).trim();
45
+ if (!answer) return ['claude'];
46
+ if (answer.toLowerCase() === 'all') return [...AGENT_NAMES];
47
+ const picked = answer.split(',').map((s) => AGENT_NAMES[Number(s.trim()) - 1]);
48
+ if (picked.some((p) => !p)) throw new BoardError('usage', `"${answer}" is not a list of numbers from 1 to ${AGENT_NAMES.length}`);
49
+ return [...new Set(picked)];
50
+ } finally { rl.close(); }
51
+ }
52
+
53
+ const instructions = (pkg) => `${START}
54
+ ## Task board (Kanban.md)
55
+
56
+ This project's tasks live in \`kanban.md\` (finished ones in \`archive.md\`).
57
+
58
+ - Use the Kanban MCP tools when they are connected (\`get_board\`, \`get_task\`, \`save_task\`, \`move_task\`, ...).
59
+ - Otherwise use the CLI, for example \`npx -y ${pkg} board\`, \`task TASK-001\`, \`move TASK-001 done\`, \`create --title "..."\`. Add \`--dry-run\` to preview. Run it with \`--help\` for everything.
60
+ - Do not read or hand-edit \`kanban.md\` while either is available: they cost far fewer tokens, validate every change and merge with the human's edits.
61
+ - Create a task before starting work, move it as you go, and reference \`TASK-NNN\` in commits. Archive only when asked.
62
+ ${END}
63
+ `;
64
+
65
+ const serverEntry = (pkg, stdio) => ({ ...(stdio ? { type: 'stdio' } : {}), command: 'npx', args: ['-y', pkg, 'mcp'] });
66
+ const same = (a, b) => JSON.stringify(a) === JSON.stringify(b);
67
+
68
+ // Insert or refresh the marked block in a Markdown file's text. Returns the new text, or null when the markers are broken.
69
+ function withBlock(text, block) {
70
+ const s = text.indexOf(START), e = text.indexOf(END);
71
+ if (s < 0 && e < 0) return text.trim() ? text.replace(/\s*$/, '\n\n') + block : block;
72
+ if (s < 0 || e < s) return null;
73
+ return text.slice(0, s) + block.trimEnd() + text.slice(e + END.length);
74
+ }
75
+
76
+ // Run the setup. `dir` is the project folder; `agents` a list of AGENT_NAMES; `pkg` the package name for npx.
77
+ export function runInit({ dir, agents, pkg, dryRun = false, force = false, mcp = true, skill = true, instructions: wantInstr = true, board = true }) {
78
+ const actions = [], manual = [], next = [];
79
+ const abs = (rel) => join(dir, rel);
80
+ const put = (rel, text, action, note) => {
81
+ if (!dryRun) { mkdirSync(dirname(abs(rel)), { recursive: true }); writeFileSync(abs(rel), text); }
82
+ actions.push({ file: rel, action, ...(note && { note }) });
83
+ };
84
+ const note = (rel, action, why) => actions.push({ file: rel, action, note: why });
85
+ const seen = new Set();
86
+ const once = (rel) => (seen.has(rel) ? false : seen.add(rel));
87
+
88
+ if (board && !existsSync(abs('kanban.md'))) put('kanban.md', createDefaultBoardContent(), 'created', 'a new empty board');
89
+
90
+ for (const name of agents) {
91
+ const a = AGENTS[name];
92
+
93
+ if (mcp && a.mcp && once(a.mcp.file)) {
94
+ const rel = a.mcp.file, entry = serverEntry(pkg, a.mcp.stdio);
95
+ let obj = {}, ok = true;
96
+ if (existsSync(abs(rel))) {
97
+ try { obj = JSON.parse(readFileSync(abs(rel), 'utf8')); } catch { ok = false; }
98
+ if (!obj || typeof obj !== 'object' || Array.isArray(obj) || (obj[a.mcp.key] !== undefined && (typeof obj[a.mcp.key] !== 'object' || Array.isArray(obj[a.mcp.key])))) ok = false;
99
+ }
100
+ if (!ok) {
101
+ note(rel, 'skipped', 'it is not plain JSON (comments?) so it was left alone; add the "kanban" entry yourself');
102
+ manual.push({ agent: name, file: rel, text: JSON.stringify({ [a.mcp.key]: { kanban: entry } }, null, 2) });
103
+ } else {
104
+ const had = existsSync(abs(rel)), cur = (obj[a.mcp.key] || {}).kanban;
105
+ if (cur && same(cur, entry)) note(rel, 'unchanged');
106
+ else if (cur && !force) note(rel, 'kept', 'it already has a different "kanban" server; use --force to replace it');
107
+ else {
108
+ obj[a.mcp.key] = { ...(obj[a.mcp.key] || {}), kanban: entry };
109
+ put(rel, JSON.stringify(obj, null, 2) + '\n', had ? 'updated' : 'created');
110
+ }
111
+ }
112
+ }
113
+
114
+ if (mcp && a.print === 'codex') {
115
+ manual.push({ agent: name, file: '~/.codex/config.toml (global)', text: `[mcp_servers.kanban]\ncommand = "npx"\nargs = ["-y", "${pkg}", "mcp"]` });
116
+ }
117
+
118
+ if (skill && a.skill && once(SKILL_REL)) {
119
+ const want = readFileSync(SKILL_SOURCE, 'utf8');
120
+ if (!existsSync(abs(SKILL_REL))) put(SKILL_REL, want, 'created');
121
+ else if (readFileSync(abs(SKILL_REL), 'utf8') === want) note(SKILL_REL, 'unchanged');
122
+ else if (force) put(SKILL_REL, want, 'updated');
123
+ else note(SKILL_REL, 'kept', 'it differs from the packaged skill (edited or older); use --force to replace it');
124
+ }
125
+
126
+ if (wantInstr) for (const rel of a.instr || []) {
127
+ if (!once(rel)) continue;
128
+ const block = instructions(pkg), had = existsSync(abs(rel));
129
+ const cur = had ? readFileSync(abs(rel), 'utf8') : '';
130
+ const out = withBlock(cur, block);
131
+ if (out === null) note(rel, 'skipped', `its ${START} / ${END} markers are unbalanced; fix or remove them and run again`);
132
+ else if (out === cur) note(rel, 'unchanged');
133
+ else put(rel, out, had ? 'updated' : 'created', had ? 'only the marked block' : undefined);
134
+ }
135
+ }
136
+
137
+ if (agents.includes('claude') && mcp) next.push('Claude Code asks you to approve the project MCP server the first time it starts a session here.');
138
+ return { agents, dryRun, actions, ...(manual.length && { manual }), ...(next.length && { next }) };
139
+ }