@rafiqui987/markode 0.3.1 → 0.4.1
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 +16 -1
- package/dist/cli.js +243 -88
- package/dist/web/assets/{abnfDiagram-WEYOIA3C-C-xz1zhH.js → abnfDiagram-WEYOIA3C-B-3Lcktj.js} +1 -1
- package/dist/web/assets/{arc-0NKn9s7n.js → arc-B1vQQwbr.js} +1 -1
- package/dist/web/assets/{architecture-WOLXFQ4H-yvNPw04L.js → architecture-WOLXFQ4H-D8_qhlNG.js} +1 -1
- package/dist/web/assets/{architectureDiagram-ZHVYKT53-DiNkPsUS.js → architectureDiagram-ZHVYKT53-B4uGFnQg.js} +1 -1
- package/dist/web/assets/{blockDiagram-RJAE7QA3-Bm5an-ZR.js → blockDiagram-RJAE7QA3-B1PRI2Fk.js} +1 -1
- package/dist/web/assets/{c4Diagram-XDPPPE54-DCIkW1i3.js → c4Diagram-XDPPPE54-BOSiNgn_.js} +1 -1
- package/dist/web/assets/channel-ggr2Mduz.js +1 -0
- package/dist/web/assets/{chunk-2E7WHVMD-w-cvaztJ.js → chunk-2E7WHVMD-B2TT-9T2.js} +1 -1
- package/dist/web/assets/{chunk-4EMNKR2T-Dz1c4ddf.js → chunk-4EMNKR2T-BJStHb31.js} +1 -1
- package/dist/web/assets/{chunk-55XCU76K-BkW2QTCZ.js → chunk-55XCU76K-CGSdzfU6.js} +1 -1
- package/dist/web/assets/{chunk-7S6XSTFO-SqLAsU6N.js → chunk-7S6XSTFO-D7U3aXUK.js} +1 -1
- package/dist/web/assets/{chunk-AQDTSKZB-DwIPdMmQ.js → chunk-AQDTSKZB-C6fkREWV.js} +1 -1
- package/dist/web/assets/{chunk-DSNLSHJZ-BNEo5raG.js → chunk-DSNLSHJZ-C0Wri32R.js} +1 -1
- package/dist/web/assets/{chunk-HAGFOTED-BokAjJjC.js → chunk-HAGFOTED-dS3yjqSY.js} +1 -1
- package/dist/web/assets/{chunk-HNE4Q36P-BlJCzrNG.js → chunk-HNE4Q36P-B0HJeFYe.js} +1 -1
- package/dist/web/assets/{chunk-NQOKRVIF-CK1D9VKN.js → chunk-NQOKRVIF-DCR-ZD6p.js} +1 -1
- package/dist/web/assets/{chunk-UHW7PFBP-ycMkWOji.js → chunk-UHW7PFBP-DvXVrsgg.js} +1 -1
- package/dist/web/assets/{chunk-VQ5W62QI-CNI8j3BI.js → chunk-VQ5W62QI-mU_IBCXT.js} +1 -1
- package/dist/web/assets/{chunk-WQQL4CDK-DvQQgYrd.js → chunk-WQQL4CDK-DnyUQt3W.js} +1 -1
- package/dist/web/assets/{chunk-XXDRQBXY-cFqAbOh1.js → chunk-XXDRQBXY-DNhISORq.js} +1 -1
- package/dist/web/assets/{chunk-YZO67HFG-CkfGL1zX.js → chunk-YZO67HFG-C_oEIdWe.js} +1 -1
- package/dist/web/assets/{chunk-ZAUX2LTX-BwdZydyj.js → chunk-ZAUX2LTX-D5aMvPiJ.js} +1 -1
- package/dist/web/assets/{chunk-ZCHMQSOR-CXDXBIC6.js → chunk-ZCHMQSOR-B5J6sRpu.js} +1 -1
- package/dist/web/assets/{classDiagram-v2-4MYWR3UA-B95ypqg8.js → classDiagram-v2-4MYWR3UA-D4-o3iga.js} +1 -1
- package/dist/web/assets/{cose-bilkent-JH36ORCC-C8-ToTGn.js → cose-bilkent-JH36ORCC-CqNUB7G6.js} +1 -1
- package/dist/web/assets/{cynefin-EF2NZ3EQ-CHth0Nt9.js → cynefin-EF2NZ3EQ-BLBtXLl2.js} +1 -1
- package/dist/web/assets/{cynefinDiagram-WF24UDRP-CMcwwxC8.js → cynefinDiagram-WF24UDRP-BlytpdKL.js} +1 -1
- package/dist/web/assets/{dagre-NK4GIZVX-BZzAgRpg.js → dagre-NK4GIZVX-DIUkOqo_.js} +1 -1
- package/dist/web/assets/{diagram-CBK3MWTC-DGwxJbVy.js → diagram-CBK3MWTC-4WJqLswq.js} +1 -1
- package/dist/web/assets/{diagram-I5XIIV2D-B17CYdAP.js → diagram-I5XIIV2D-s1EUO6xt.js} +1 -1
- package/dist/web/assets/{diagram-ODIL2UCW-CYPFYS2M.js → diagram-ODIL2UCW-GvgDR4t8.js} +1 -1
- package/dist/web/assets/{diagram-PFBEJUXE-BQMumROl.js → diagram-PFBEJUXE-B6J9SedW.js} +1 -1
- package/dist/web/assets/{diagram-RJA3I4VV-vHTuDO1-.js → diagram-RJA3I4VV-CqA7qcNf.js} +1 -1
- package/dist/web/assets/{diagram-TYUNFSNR-C_WYz7qL.js → diagram-TYUNFSNR-Cln9POlx.js} +1 -1
- package/dist/web/assets/{dist-DFcDEdTm.js → dist--fImHE6g.js} +1 -1
- package/dist/web/assets/{dist-BOCA4kQq.js → dist-Bg-QtHy9.js} +1 -1
- package/dist/web/assets/{dist-cSM0Lli0.js → dist-BghTt_37.js} +1 -1
- package/dist/web/assets/{dist-PwT2nxki.js → dist-CU6eXj3N.js} +1 -1
- package/dist/web/assets/{dist-B1oQ1VTT.js → dist-CVF0b6Yz.js} +1 -1
- package/dist/web/assets/{dist-B5uXb_Wi.js → dist-Cd1DR3ly.js} +1 -1
- package/dist/web/assets/{dist-8k6FSdRu.js → dist-CoioyMmF.js} +1 -1
- package/dist/web/assets/{dist-DV0HO3Fe.js → dist-CykDxBaO.js} +1 -1
- package/dist/web/assets/{dist-QI7QavRs.js → dist-DpqggjJG.js} +1 -1
- package/dist/web/assets/{dist-DZQ_bwip.js → dist-YudOLIZ5.js} +1 -1
- package/dist/web/assets/{dist-BT3nK1GA.js → dist-xGXJDvke.js} +1 -1
- package/dist/web/assets/{ebnfDiagram-V4P3TTPT-DLMwyX-U.js → ebnfDiagram-V4P3TTPT-BusXM5tX.js} +1 -1
- package/dist/web/assets/{elk-QONTBCTQ-DVvxbtF4.js → elk-QONTBCTQ-B9oq7Tkq.js} +1 -1
- package/dist/web/assets/{erDiagram-KYQIGQAA-DPXicJ1t.js → erDiagram-KYQIGQAA-CmL9SAnh.js} +1 -1
- package/dist/web/assets/{eventmodeling-K75KTNOO-DpHVZP_6.js → eventmodeling-K75KTNOO-R6NmozzN.js} +1 -1
- package/dist/web/assets/flowDiagram-IUGLLWBU-CkUCRx3C.js +1 -0
- package/dist/web/assets/{ganttDiagram-R7GPNTJY-Ch6NDX5Q.js → ganttDiagram-R7GPNTJY-DRa2V_Qe.js} +1 -1
- package/dist/web/assets/{gitGraph-VSP46ZUC-CIhLB663.js → gitGraph-VSP46ZUC-CdFMO2LD.js} +1 -1
- package/dist/web/assets/{gitGraphDiagram-PDYL7XHY-Ci_MIbqs.js → gitGraphDiagram-PDYL7XHY-C-xmUbl1.js} +1 -1
- package/dist/web/assets/{index-CxwfaWVo.js → index-BFpTDsCp.js} +4 -4
- package/dist/web/assets/{info-OHQRW6UA-Dau8xD88.js → info-OHQRW6UA-CnPUMAqS.js} +1 -1
- package/dist/web/assets/{infoDiagram-MVDRKAX5-4spgggd7.js → infoDiagram-MVDRKAX5-DxouwrN7.js} +1 -1
- package/dist/web/assets/{ishikawaDiagram-HPEHV2GE-DgFczAdB.js → ishikawaDiagram-HPEHV2GE-qrLpOq3_.js} +1 -1
- package/dist/web/assets/{journeyDiagram-BOSHW7O7-CJKwCuyG.js → journeyDiagram-BOSHW7O7-BDTfHWHd.js} +1 -1
- package/dist/web/assets/{kanban-definition-FNSA4HC5-B_HPa_Q8.js → kanban-definition-FNSA4HC5-CTBgSpp6.js} +1 -1
- package/dist/web/assets/{line-Bil8yI0B.js → line-D8R5RRtF.js} +1 -1
- package/dist/web/assets/{linear-DJSxHb3I.js → linear-BCL193tG.js} +1 -1
- package/dist/web/assets/{mermaid-parser.core-ByEdgqAb.js → mermaid-parser.core-C1XIxySl.js} +3 -3
- package/dist/web/assets/{mermaid.core-CXUI3iYT.js → mermaid.core-C-385ykR.js} +4 -4
- package/dist/web/assets/{mindmap-definition-6OY57UG3-w7xG6UiS.js → mindmap-definition-6OY57UG3-BnCvQFLY.js} +1 -1
- package/dist/web/assets/{packet-JDAUHWVQ-YvTb_dXP.js → packet-JDAUHWVQ-DVCRx-wc.js} +1 -1
- package/dist/web/assets/{pegDiagram-ECIUJNBX-D5FI1bVJ.js → pegDiagram-ECIUJNBX-CIDVz_ln.js} +1 -1
- package/dist/web/assets/{pie-XZMESJXO-BH2bih-K.js → pie-XZMESJXO-BHXvmR-y.js} +1 -1
- package/dist/web/assets/{pieDiagram-GNMPY74T-DUR82NlG.js → pieDiagram-GNMPY74T-Bb_l0cKd.js} +1 -1
- package/dist/web/assets/{quadrantDiagram-D57K4MC3-DauAEIyL.js → quadrantDiagram-D57K4MC3-Dqq4AGQt.js} +1 -1
- package/dist/web/assets/{radar-ABXABTNO-CdUXfEdf.js → radar-ABXABTNO-Ba5vnnQ7.js} +1 -1
- package/dist/web/assets/{railroad-I3PHUGI6-Djt90nhE.js → railroad-I3PHUGI6-CxoMtJ5h.js} +1 -1
- package/dist/web/assets/{railroad-abnf-LNEFI6M7-XqY0pGCO.js → railroad-abnf-LNEFI6M7-BXxErwiU.js} +1 -1
- package/dist/web/assets/{railroad-ebnf-DWYD2UWJ-BNSOgId4.js → railroad-ebnf-DWYD2UWJ-C_9H5arK.js} +1 -1
- package/dist/web/assets/{railroad-peg-JR7BVNR7-DW2TRqOr.js → railroad-peg-JR7BVNR7-50KHJESB.js} +1 -1
- package/dist/web/assets/{railroadDiagram-Y72NRBL7-CTDNRHBf.js → railroadDiagram-Y72NRBL7-9w1amWMc.js} +1 -1
- package/dist/web/assets/{requirementDiagram-EQYSW5RA-DJ5H8uqE.js → requirementDiagram-EQYSW5RA-D3XygoSz.js} +1 -1
- package/dist/web/assets/{sankeyDiagram-SY24JHO5-Xa_3Bd4U.js → sankeyDiagram-SY24JHO5-C68crPY9.js} +1 -1
- package/dist/web/assets/{sequenceDiagram-BLEHNHQU-2jNpfI3_.js → sequenceDiagram-BLEHNHQU-BNcJ1wfc.js} +1 -1
- package/dist/web/assets/{src-DgNmQVK4.js → src-okGi814h.js} +1 -1
- package/dist/web/assets/{stateDiagram-v2-A6IESKWZ-DtxzihUG.js → stateDiagram-v2-A6IESKWZ-DX7rAO1j.js} +1 -1
- package/dist/web/assets/{swimlanes-B3ENRKFQ-DJBCOj2u.js → swimlanes-B3ENRKFQ-DGSmz_ab.js} +1 -1
- package/dist/web/assets/swimlanesDiagram-AYQRV4AK-D8bRrq1P.js +8 -0
- package/dist/web/assets/{timeline-definition-JXYKGLGB-C-ixUm6b.js → timeline-definition-JXYKGLGB-5COU2ouX.js} +1 -1
- package/dist/web/assets/{treeView-D4JQ5SDB-yWRFH4mR.js → treeView-D4JQ5SDB-BgrtWP9w.js} +1 -1
- package/dist/web/assets/{treemap-SAJKECNS-q3FZ9UjJ.js → treemap-SAJKECNS-CLZcktWl.js} +1 -1
- package/dist/web/assets/{usecaseDiagram-WPOLBNNX-Ch9QG7L1.js → usecaseDiagram-WPOLBNNX-BbJ7QjYR.js} +1 -1
- package/dist/web/assets/{vennDiagram-Q3Y3IDCW-85m0XMhF.js → vennDiagram-Q3Y3IDCW-IhZTghFG.js} +1 -1
- package/dist/web/assets/{wardley-7MLQ67FV-S2NRiIdM.js → wardley-7MLQ67FV-XjDz9vxn.js} +1 -1
- package/dist/web/assets/{wardleyDiagram-IVAIDKWA-q8ZLrvVG.js → wardleyDiagram-IVAIDKWA-DTcLR0T-.js} +1 -1
- package/dist/web/assets/{xychartDiagram-4URNHDU4-eSUy1iT7.js → xychartDiagram-4URNHDU4-Dja-ugvw.js} +1 -1
- package/dist/web/index.html +1 -1
- package/package.json +1 -1
- package/templates/proposals/SKILL.md +2 -1
- package/templates/skill/SKILL.md +18 -1
- package/dist/web/assets/channel-BkrEjK89.js +0 -1
- package/dist/web/assets/flowDiagram-IUGLLWBU-DrcHkm4d.js +0 -1
- package/dist/web/assets/swimlanesDiagram-AYQRV4AK-_cBuwUIk.js +0 -8
package/README.md
CHANGED
|
@@ -369,6 +369,8 @@ missing description, a name that doesn't match its folder…).
|
|
|
369
369
|
markode # set up the project if needed, then open the editor
|
|
370
370
|
markode serve # open the editor without the setup
|
|
371
371
|
markode serve --port 5000 --no-open
|
|
372
|
+
markode url [<doc.md>] # the editor's link (or a doc's); starts it in the background if needed
|
|
373
|
+
markode stop # stop the editor started in the background
|
|
372
374
|
markode init # run the setup again: only adds modules (your defaults, if saved)
|
|
373
375
|
markode init --profile full # no questions: viewer, agent or full
|
|
374
376
|
markode init --yes # no questions: your defaults, or viewer + AI agent
|
|
@@ -380,20 +382,27 @@ markode features # which modules are on, with what each one does
|
|
|
380
382
|
markode features live off # turn a module on or off (same as Settings → Features)
|
|
381
383
|
markode translate # choose languages to review the docs in (also: markode --translate)
|
|
382
384
|
markode link # only CLAUDE.md or only AGENTS.md? add the other one, pointing to it
|
|
385
|
+
markode update # install the latest version now (see below)
|
|
383
386
|
markode -v # version
|
|
384
387
|
```
|
|
385
388
|
|
|
386
389
|
To keep it installed: `npm install -g @rafiqui987/markode` (or `pnpm add -g @rafiqui987/markode`).
|
|
387
390
|
Installing it also makes the Claude Code hooks faster than running through `npx`.
|
|
388
391
|
|
|
392
|
+
**A new version right away.** pnpm (and npm with `min-release-age`) wait a day before installing a
|
|
393
|
+
version just published. `markode update` asks the npm registry for the latest version and installs it
|
|
394
|
+
now, with the same package manager that installed markode (`--pnpm` or `--npm` to choose);
|
|
395
|
+
`markode update --check` only says whether there is one.
|
|
396
|
+
|
|
389
397
|
## For AI agents
|
|
390
398
|
|
|
391
399
|
The AI agent module installs the `markode` skill where the project's agents read skills
|
|
392
400
|
(`.claude/skills/` for Claude Code, `.agents/skills/` for Codex, Copilot, Gemini and others). It tells
|
|
393
|
-
the agent how to write Markdown that markode presents well, and gives it
|
|
401
|
+
the agent how to write Markdown that markode presents well, and gives it three commands:
|
|
394
402
|
|
|
395
403
|
| Command | What the agent does | When |
|
|
396
404
|
|---|---|---|
|
|
405
|
+
| `/markode` | Starts the editor in the background if it isn't running and gives you its link (`markode url`) | When you want to open markode |
|
|
397
406
|
| `/markode sync` | Keeps the docs consistent: applies answered proposals, ticks phases from their tasks, checks the projects table and broken links (`markode check`) | Start and end of a session, after editing docs |
|
|
398
407
|
| `/markode translate` | Translates what is behind; asks before changing any source file | Only when you ask |
|
|
399
408
|
|
|
@@ -404,6 +413,11 @@ enough. In the main doc it writes only between its markers:
|
|
|
404
413
|
- `markode:workflow`: how the project plans its work (the markode method, OpenSpec or Spec Kit);
|
|
405
414
|
- `markode:proposals`: how the agent writes proposals and answers comments.
|
|
406
415
|
|
|
416
|
+
**Links to docs.** When the agent points you to a doc (a proposal it wrote, a doc it changed), it gives
|
|
417
|
+
a link you can click in the terminal: `http://localhost:4319/open?path=docs/proposals/003-auth.md`. The
|
|
418
|
+
markode tab you already have open shows that doc, and the tab the click opened closes itself, so you
|
|
419
|
+
keep a single markode tab. With no markode tab open, the link opens the editor on that doc.
|
|
420
|
+
|
|
407
421
|
When the agent writes a proposal, it runs `markode wait <proposal>` in the background: it waits
|
|
408
422
|
without using tokens until you press "Done, send my answer", then hands the agent your choices, open
|
|
409
423
|
questions and comments. If no session was open, the next one applies the answer first.
|
|
@@ -426,6 +440,7 @@ module, in projects that use Claude Code, markode adds three hooks to `.claude/s
|
|
|
426
440
|
Without a global install the command is `npx -y --prefer-offline @rafiqui987/markode`.
|
|
427
441
|
|
|
428
442
|
```bash
|
|
443
|
+
markode url [<doc.md>] # link to the editor or a doc (starts it if needed)
|
|
429
444
|
markode check [--json] # what /markode sync fixes
|
|
430
445
|
markode wait <proposal.md> # wait for the user's answer, then print it
|
|
431
446
|
markode changes [--json] # the user's edits and comments since last told
|