proofdeck 0.0.0-stage → 0.1.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.
Files changed (139) hide show
  1. package/LICENSE +201 -0
  2. package/NOTICE +23 -0
  3. package/README.md +152 -2
  4. package/README.zh-CN.md +152 -0
  5. package/bin/proofdeck.js +191 -0
  6. package/board/LICENSE +201 -0
  7. package/board/README.md +473 -0
  8. package/board/README.zh-CN.md +424 -0
  9. package/board/dist/_chk.db-shm +0 -0
  10. package/board/dist/_chk.db-wal +0 -0
  11. package/board/dist/adapters.d.ts +40 -0
  12. package/board/dist/adapters.d.ts.map +1 -0
  13. package/board/dist/adapters.js +124 -0
  14. package/board/dist/adapters.js.map +1 -0
  15. package/board/dist/board.d.ts +628 -0
  16. package/board/dist/board.d.ts.map +1 -0
  17. package/board/dist/board.js +2767 -0
  18. package/board/dist/board.js.map +1 -0
  19. package/board/dist/cli.d.ts +3 -0
  20. package/board/dist/cli.d.ts.map +1 -0
  21. package/board/dist/cli.js +1663 -0
  22. package/board/dist/cli.js.map +1 -0
  23. package/board/dist/config.d.ts +57 -0
  24. package/board/dist/config.d.ts.map +1 -0
  25. package/board/dist/config.js +99 -0
  26. package/board/dist/config.js.map +1 -0
  27. package/board/dist/db.d.ts +9 -0
  28. package/board/dist/db.d.ts.map +1 -0
  29. package/board/dist/db.js +506 -0
  30. package/board/dist/db.js.map +1 -0
  31. package/board/dist/git.d.ts +35 -0
  32. package/board/dist/git.d.ts.map +1 -0
  33. package/board/dist/git.js +147 -0
  34. package/board/dist/git.js.map +1 -0
  35. package/board/dist/index.d.ts +18 -0
  36. package/board/dist/index.d.ts.map +1 -0
  37. package/board/dist/index.js +13 -0
  38. package/board/dist/index.js.map +1 -0
  39. package/board/dist/mcp-config.d.ts +26 -0
  40. package/board/dist/mcp-config.d.ts.map +1 -0
  41. package/board/dist/mcp-config.js +88 -0
  42. package/board/dist/mcp-config.js.map +1 -0
  43. package/board/dist/mcp.d.ts +3 -0
  44. package/board/dist/mcp.d.ts.map +1 -0
  45. package/board/dist/mcp.js +949 -0
  46. package/board/dist/mcp.js.map +1 -0
  47. package/board/dist/quickstart.d.ts +75 -0
  48. package/board/dist/quickstart.d.ts.map +1 -0
  49. package/board/dist/quickstart.js +156 -0
  50. package/board/dist/quickstart.js.map +1 -0
  51. package/board/dist/serve.d.ts +10 -0
  52. package/board/dist/serve.d.ts.map +1 -0
  53. package/board/dist/serve.js +445 -0
  54. package/board/dist/serve.js.map +1 -0
  55. package/board/dist/signing.d.ts +18 -0
  56. package/board/dist/signing.d.ts.map +1 -0
  57. package/board/dist/signing.js +26 -0
  58. package/board/dist/signing.js.map +1 -0
  59. package/board/dist/sync.d.ts +49 -0
  60. package/board/dist/sync.d.ts.map +1 -0
  61. package/board/dist/sync.js +158 -0
  62. package/board/dist/sync.js.map +1 -0
  63. package/board/dist/types.d.ts +359 -0
  64. package/board/dist/types.d.ts.map +1 -0
  65. package/board/dist/types.js +20 -0
  66. package/board/dist/types.js.map +1 -0
  67. package/board/docs/adr/0001-shared-worktree-collision.md +102 -0
  68. package/board/docs/adr/0001-shared-worktree-collision.zh-CN.md +90 -0
  69. package/board/docs/attribution.md +123 -0
  70. package/board/docs/attribution.zh-CN.md +104 -0
  71. package/board/docs/development-workflow.md +81 -0
  72. package/board/docs/development-workflow.zh-CN.md +75 -0
  73. package/board/docs/diagrams/banner.png +0 -0
  74. package/board/docs/diagrams/banner.svg +1 -0
  75. package/board/docs/diagrams/before-after.png +0 -0
  76. package/board/docs/diagrams/before-after.svg +1 -0
  77. package/board/docs/diagrams/governance-chain.png +0 -0
  78. package/board/docs/diagrams/governance-chain.svg +1 -0
  79. package/board/docs/diagrams/value-flow.png +0 -0
  80. package/board/docs/diagrams/value-flow.svg +1 -0
  81. package/board/docs/entry-point.md +81 -0
  82. package/board/docs/entry-point.zh-CN.md +65 -0
  83. package/board/docs/kanban.png +0 -0
  84. package/board/docs/octoryn-mark.png +0 -0
  85. package/board/docs/registry-metadata.md +34 -0
  86. package/board/docs/registry-metadata.zh-CN.md +30 -0
  87. package/board/package.json +87 -0
  88. package/config.example.json +72 -0
  89. package/daemon.js +1148 -0
  90. package/docs/assets/demo.gif +0 -0
  91. package/docs/assets/logo-512.png +0 -0
  92. package/docs/assets/logo.svg +31 -0
  93. package/docs/assets/social-preview.png +0 -0
  94. package/docs/demo-run.mjs +61 -0
  95. package/docs/render-demo.py +94 -0
  96. package/docs/render-logo.py +101 -0
  97. package/docs/task-book.md +58 -0
  98. package/e2e/verify-acceptance.mjs +150 -0
  99. package/e2e/verify-antifraud.mjs +128 -0
  100. package/e2e/verify-caps.mjs +46 -0
  101. package/e2e/verify-checkpoint.mjs +208 -0
  102. package/e2e/verify-firstclass.mjs +110 -0
  103. package/e2e/verify-judge.mjs +52 -0
  104. package/e2e/verify-lease.mjs +95 -0
  105. package/e2e/verify-replay.mjs +92 -0
  106. package/e2e/verify-resilience.mjs +323 -0
  107. package/e2e/verify-review.mjs +86 -0
  108. package/e2e/verify-scheduling.mjs +110 -0
  109. package/e2e/verify-schema-evolution.mjs +107 -0
  110. package/e2e/verify-sla-digest.mjs +105 -0
  111. package/guard.js +97 -0
  112. package/lib/adapters/codex.js +206 -0
  113. package/lib/billing-convert.js +57 -0
  114. package/lib/board.js +46 -0
  115. package/lib/caps.js +35 -0
  116. package/lib/checkpoint.js +130 -0
  117. package/lib/gating.js +218 -0
  118. package/lib/guard-core.mjs +108 -0
  119. package/lib/http.js +161 -0
  120. package/lib/judge.js +89 -0
  121. package/lib/lease.js +93 -0
  122. package/lib/notify.js +56 -0
  123. package/lib/platform.js +120 -0
  124. package/lib/replay.js +68 -0
  125. package/lib/review.js +40 -0
  126. package/lib/runner.js +152 -0
  127. package/lib/schedule.js +59 -0
  128. package/lib/sla.js +42 -0
  129. package/lib/spans.js +36 -0
  130. package/lib/starve.js +43 -0
  131. package/lib/store.js +109 -0
  132. package/lib/supply.js +101 -0
  133. package/lib/usage.js +103 -0
  134. package/lib/verify.js +223 -0
  135. package/lib/watchdog-core.mjs +68 -0
  136. package/lib/watchdog-worker.mjs +75 -0
  137. package/package.json +55 -4
  138. package/scripts/run-daemon.sh +18 -0
  139. package/scripts/run-e2e.mjs +39 -0
@@ -0,0 +1,147 @@
1
+ import { execFileSync } from "node:child_process";
2
+ /**
3
+ * Read-only (and append-only) Git helpers.
4
+ *
5
+ * The blackboard NEVER rewrites Git history. Everything here either reads Git
6
+ * (branch, remote, commit contents, blame) or writes additive metadata that
7
+ * does not touch existing commits (`git notes`). Git remains the source of
8
+ * code; the blackboard is the source of attribution.
9
+ *
10
+ * Every function degrades gracefully outside a repository — returning
11
+ * `undefined` rather than throwing — so the board works with or without Git.
12
+ */
13
+ function git(args, cwd = process.cwd()) {
14
+ try {
15
+ return execFileSync("git", args, {
16
+ cwd,
17
+ encoding: "utf8",
18
+ stdio: ["ignore", "pipe", "ignore"],
19
+ }).trim();
20
+ }
21
+ catch {
22
+ return undefined;
23
+ }
24
+ }
25
+ export function isRepo(cwd = process.cwd()) {
26
+ return git(["rev-parse", "--is-inside-work-tree"], cwd) === "true";
27
+ }
28
+ export function repoRoot(cwd = process.cwd()) {
29
+ return git(["rev-parse", "--show-toplevel"], cwd);
30
+ }
31
+ export function currentBranch(cwd = process.cwd()) {
32
+ const branch = git(["rev-parse", "--abbrev-ref", "HEAD"], cwd);
33
+ return branch === "HEAD" ? undefined : branch; // detached HEAD
34
+ }
35
+ export function remoteUrl(cwd = process.cwd()) {
36
+ return git(["remote", "get-url", "origin"], cwd);
37
+ }
38
+ /** Resolve any revision (HEAD, a tag, short sha) to a full commit sha. */
39
+ export function resolveRev(rev, cwd = process.cwd()) {
40
+ // `--end-of-options` stops a dashed `rev` from being read as a rev-parse flag.
41
+ return git(["rev-parse", "--verify", "--end-of-options", `${rev}^{commit}`], cwd);
42
+ }
43
+ /**
44
+ * List commit shas in a revision range (e.g. `main..HEAD`), newest first.
45
+ * `--end-of-options` blocks flag injection via a dashed range.
46
+ */
47
+ export function revList(range, cwd = process.cwd()) {
48
+ const out = git(["rev-list", "--end-of-options", range], cwd);
49
+ if (!out) {
50
+ return [];
51
+ }
52
+ return out
53
+ .split("\n")
54
+ .map((l) => l.trim())
55
+ .filter((l) => l.length > 0);
56
+ }
57
+ export function commitInfo(rev, cwd = process.cwd()) {
58
+ // `--end-of-options` stops flag parsing: a `rev` starting with `-` can never
59
+ // be treated as a git option (e.g. `--output=<path>` file write). See safeRev.
60
+ const out = git([
61
+ "show",
62
+ "-s",
63
+ "--format=%H%x1f%an%x1f%ae%x1f%aI%x1f%s",
64
+ "--end-of-options",
65
+ rev,
66
+ ], cwd);
67
+ if (!out) {
68
+ return undefined;
69
+ }
70
+ const parts = out.split("\x1f");
71
+ if (parts.length < 5) {
72
+ return undefined;
73
+ }
74
+ const [sha, author, authorEmail, date, subject] = parts;
75
+ return { sha, author, authorEmail, date, subject };
76
+ }
77
+ /** Files touched by a commit (paths relative to the repo root). */
78
+ export function filesInCommit(rev, cwd = process.cwd()) {
79
+ // `-z` disables path C-quoting so non-ASCII / whitespace filenames survive
80
+ // intact; `--end-of-options` blocks flag injection via a dashed `rev`.
81
+ const out = git([
82
+ "show",
83
+ "--name-only",
84
+ "--format=",
85
+ "--no-renames",
86
+ "-z",
87
+ "--end-of-options",
88
+ rev,
89
+ ], cwd);
90
+ if (!out) {
91
+ return [];
92
+ }
93
+ // NUL-delimited; with `--format=` a leading empty field precedes the paths.
94
+ return out.split("\0").filter((p) => p.length > 0);
95
+ }
96
+ /** Distinct Git authors that have touched a file (from `git log`). */
97
+ export function fileAuthors(file, cwd = process.cwd()) {
98
+ // `--` marks the end of options; `file` is unambiguously a pathspec.
99
+ const out = git(["log", "--format=%an", "--", file], cwd);
100
+ if (!out) {
101
+ return [];
102
+ }
103
+ return [
104
+ ...new Set(out
105
+ .split("\n")
106
+ .map((l) => l.trim())
107
+ .filter(Boolean)),
108
+ ];
109
+ }
110
+ /** Resolve which commit last modified a specific line — `git blame -L`. */
111
+ export function blameLine(file, line, cwd = process.cwd()) {
112
+ // `--` ensures a `file` beginning with `-` is a pathspec, not a blame flag
113
+ // (e.g. `--contents=<path>`).
114
+ const out = git(["blame", "-L", `${line},${line}`, "--porcelain", "--", file], cwd);
115
+ if (!out) {
116
+ return undefined;
117
+ }
118
+ const sha = out.split("\n")[0]?.split(" ")[0];
119
+ const authorLine = out.split("\n").find((l) => l.startsWith("author "));
120
+ const author = authorLine ? authorLine.slice("author ".length) : "unknown";
121
+ if (!sha) {
122
+ return undefined;
123
+ }
124
+ return { sha, author };
125
+ }
126
+ /**
127
+ * Append attribution as a Git note under `refs/notes/blackboard`. Notes are
128
+ * additive: they never alter the commit or its sha. Returns true on success.
129
+ */
130
+ export function writeNote(rev, note, cwd = process.cwd()) {
131
+ // `note` is data (bound after `-m`); `--end-of-options` guards the object rev.
132
+ const res = git([
133
+ "notes",
134
+ "--ref=blackboard",
135
+ "add",
136
+ "-f",
137
+ "-m",
138
+ note,
139
+ "--end-of-options",
140
+ rev,
141
+ ], cwd);
142
+ return res !== undefined;
143
+ }
144
+ export function readNote(rev, cwd = process.cwd()) {
145
+ return git(["notes", "--ref=blackboard", "show", "--end-of-options", rev], cwd);
146
+ }
147
+ //# sourceMappingURL=git.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"git.js","sourceRoot":"","sources":["../src/git.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD;;;;;;;;;;GAUG;AAEH,SAAS,GAAG,CAAC,IAAc,EAAE,MAAc,OAAO,CAAC,GAAG,EAAE;IACtD,IAAI,CAAC;QACH,OAAO,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE;YAC/B,GAAG;YACH,QAAQ,EAAE,MAAM;YAChB,KAAK,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC;SACpC,CAAC,CAAC,IAAI,EAAE,CAAC;IACZ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,MAAc,OAAO,CAAC,GAAG,EAAE;IAChD,OAAO,GAAG,CAAC,CAAC,WAAW,EAAE,uBAAuB,CAAC,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC;AACrE,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,MAAc,OAAO,CAAC,GAAG,EAAE;IAClD,OAAO,GAAG,CAAC,CAAC,WAAW,EAAE,iBAAiB,CAAC,EAAE,GAAG,CAAC,CAAC;AACpD,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,MAAc,OAAO,CAAC,GAAG,EAAE;IACvD,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,WAAW,EAAE,cAAc,EAAE,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC;IAC/D,OAAO,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,gBAAgB;AACjE,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,MAAc,OAAO,CAAC,GAAG,EAAE;IACnD,OAAO,GAAG,CAAC,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,GAAG,CAAC,CAAC;AACnD,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,UAAU,CACxB,GAAW,EACX,MAAc,OAAO,CAAC,GAAG,EAAE;IAE3B,+EAA+E;IAC/E,OAAO,GAAG,CACR,CAAC,WAAW,EAAE,UAAU,EAAE,kBAAkB,EAAE,GAAG,GAAG,WAAW,CAAC,EAChE,GAAG,CACJ,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,OAAO,CAAC,KAAa,EAAE,MAAc,OAAO,CAAC,GAAG,EAAE;IAChE,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,UAAU,EAAE,kBAAkB,EAAE,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC;IAC9D,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,OAAO,GAAG;SACP,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACpB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AACjC,CAAC;AAUD,MAAM,UAAU,UAAU,CACxB,GAAW,EACX,MAAc,OAAO,CAAC,GAAG,EAAE;IAE3B,6EAA6E;IAC7E,+EAA+E;IAC/E,MAAM,GAAG,GAAG,GAAG,CACb;QACE,MAAM;QACN,IAAI;QACJ,wCAAwC;QACxC,kBAAkB;QAClB,GAAG;KACJ,EACD,GAAG,CACJ,CAAC;IACF,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAChC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC;IACxD,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AACrD,CAAC;AAED,mEAAmE;AACnE,MAAM,UAAU,aAAa,CAC3B,GAAW,EACX,MAAc,OAAO,CAAC,GAAG,EAAE;IAE3B,2EAA2E;IAC3E,uEAAuE;IACvE,MAAM,GAAG,GAAG,GAAG,CACb;QACE,MAAM;QACN,aAAa;QACb,WAAW;QACX,cAAc;QACd,IAAI;QACJ,kBAAkB;QAClB,GAAG;KACJ,EACD,GAAG,CACJ,CAAC;IACF,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,4EAA4E;IAC5E,OAAO,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AACrD,CAAC;AAED,sEAAsE;AACtE,MAAM,UAAU,WAAW,CACzB,IAAY,EACZ,MAAc,OAAO,CAAC,GAAG,EAAE;IAE3B,qEAAqE;IACrE,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;IAC1D,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,OAAO;QACL,GAAG,IAAI,GAAG,CACR,GAAG;aACA,KAAK,CAAC,IAAI,CAAC;aACX,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aACpB,MAAM,CAAC,OAAO,CAAC,CACnB;KACF,CAAC;AACJ,CAAC;AAED,2EAA2E;AAC3E,MAAM,UAAU,SAAS,CACvB,IAAY,EACZ,IAAY,EACZ,MAAc,OAAO,CAAC,GAAG,EAAE;IAE3B,2EAA2E;IAC3E,8BAA8B;IAC9B,MAAM,GAAG,GAAG,GAAG,CACb,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,IAAI,IAAI,IAAI,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,CAAC,EAC7D,GAAG,CACJ,CAAC;IACF,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9C,MAAM,UAAU,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;IACxE,MAAM,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3E,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;AACzB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,SAAS,CACvB,GAAW,EACX,IAAY,EACZ,MAAc,OAAO,CAAC,GAAG,EAAE;IAE3B,+EAA+E;IAC/E,MAAM,GAAG,GAAG,GAAG,CACb;QACE,OAAO;QACP,kBAAkB;QAClB,KAAK;QACL,IAAI;QACJ,IAAI;QACJ,IAAI;QACJ,kBAAkB;QAClB,GAAG;KACJ,EACD,GAAG,CACJ,CAAC;IACF,OAAO,GAAG,KAAK,SAAS,CAAC;AAC3B,CAAC;AAED,MAAM,UAAU,QAAQ,CACtB,GAAW,EACX,MAAc,OAAO,CAAC,GAAG,EAAE;IAE3B,OAAO,GAAG,CACR,CAAC,OAAO,EAAE,kBAAkB,EAAE,MAAM,EAAE,kBAAkB,EAAE,GAAG,CAAC,EAC9D,GAAG,CACJ,CAAC;AACJ,CAAC"}
@@ -0,0 +1,18 @@
1
+ /**
2
+ * Octopus Blackboard — a shared memory and coordination layer for AI coding
3
+ * agents. Programmatic entry point; see `cli.ts` for the `octoboard` command
4
+ * and `mcp.ts` for the MCP server.
5
+ */
6
+ export { Board, BUNDLE_VERSION } from "./board.js";
7
+ export type { ClaimResult, ChainVerification, PolicyResult, PolicyViolation, PolicyOptions, AttributionBundle, Report, } from "./board.js";
8
+ export { serve } from "./serve.js";
9
+ export { createSyncTarget, FileSyncTarget, PostgresSyncTarget, } from "./sync.js";
10
+ export type { SyncTarget, SyncCounts } from "./sync.js";
11
+ export { getAdapter, genericAdapter, ADAPTERS } from "./adapters.js";
12
+ export type { Adapter, IngestEvent } from "./adapters.js";
13
+ export { mcpConfig, MCP_CLIENTS } from "./mcp-config.js";
14
+ export type { McpClient, McpConfigOptions, McpConfigResult, } from "./mcp-config.js";
15
+ export { loadConfig, resolveBoardDir, findBoardDir } from "./config.js";
16
+ export type { BoardConfig, ConfigOverrides } from "./config.js";
17
+ export * from "./types.js";
18
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACnD,YAAY,EACV,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,eAAe,EACf,aAAa,EACb,iBAAiB,EACjB,MAAM,GACP,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,kBAAkB,GACnB,MAAM,WAAW,CAAC;AACnB,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACrE,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACzD,YAAY,EACV,SAAS,EACT,gBAAgB,EAChB,eAAe,GAChB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACxE,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAChE,cAAc,YAAY,CAAC"}
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Octopus Blackboard — a shared memory and coordination layer for AI coding
3
+ * agents. Programmatic entry point; see `cli.ts` for the `octoboard` command
4
+ * and `mcp.ts` for the MCP server.
5
+ */
6
+ export { Board, BUNDLE_VERSION } from "./board.js";
7
+ export { serve } from "./serve.js";
8
+ export { createSyncTarget, FileSyncTarget, PostgresSyncTarget, } from "./sync.js";
9
+ export { getAdapter, genericAdapter, ADAPTERS } from "./adapters.js";
10
+ export { mcpConfig, MCP_CLIENTS } from "./mcp-config.js";
11
+ export { loadConfig, resolveBoardDir, findBoardDir } from "./config.js";
12
+ export * from "./types.js";
13
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAUnD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,kBAAkB,GACnB,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAErE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAMzD,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAExE,cAAc,YAAY,CAAC"}
@@ -0,0 +1,26 @@
1
+ /**
2
+ * Generate ready-to-paste MCP client configuration so any CLI can connect to
3
+ * the blackboard with one step. The server is provider-independent and speaks
4
+ * standard MCP over stdio, so the same command works everywhere; only the
5
+ * config file format and location differ per client.
6
+ */
7
+ export interface McpConfigOptions {
8
+ /** Identity the server writes under (defaults to the client name). */
9
+ agent?: string;
10
+ /** Explicit board directory; omitted → the server discovers .octoboard/. */
11
+ boardDir?: string;
12
+ /** Use a local build path instead of the published npx bin (dev). */
13
+ localEntry?: string;
14
+ }
15
+ export declare const MCP_CLIENTS: readonly ["json", "claude-code", "cursor", "codex", "gemini", "vscode", "windsurf"];
16
+ export type McpClient = (typeof MCP_CLIENTS)[number];
17
+ export interface McpConfigResult {
18
+ /** Where the user should put this config. */
19
+ path: string;
20
+ /** The config text to paste. */
21
+ content: string;
22
+ /** Optional extra guidance. */
23
+ note?: string;
24
+ }
25
+ export declare function mcpConfig(client: McpClient, opts?: McpConfigOptions): McpConfigResult;
26
+ //# sourceMappingURL=mcp-config.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"mcp-config.d.ts","sourceRoot":"","sources":["../src/mcp-config.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,WAAW,gBAAgB;IAC/B,sEAAsE;IACtE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qEAAqE;IACrE,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,eAAO,MAAM,WAAW,qFAQd,CAAC;AACX,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC;AAyCrD,MAAM,WAAW,eAAe;IAC9B,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,+BAA+B;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,wBAAgB,SAAS,CACvB,MAAM,EAAE,SAAS,EACjB,IAAI,GAAE,gBAAqB,GAC1B,eAAe,CAyCjB"}
@@ -0,0 +1,88 @@
1
+ /**
2
+ * Generate ready-to-paste MCP client configuration so any CLI can connect to
3
+ * the blackboard with one step. The server is provider-independent and speaks
4
+ * standard MCP over stdio, so the same command works everywhere; only the
5
+ * config file format and location differ per client.
6
+ */
7
+ export const MCP_CLIENTS = [
8
+ "json",
9
+ "claude-code",
10
+ "cursor",
11
+ "codex",
12
+ "gemini",
13
+ "vscode",
14
+ "windsurf",
15
+ ];
16
+ function serverSpec(agent, opts) {
17
+ const command = opts.localEntry ? "node" : "npx";
18
+ const args = opts.localEntry
19
+ ? [opts.localEntry]
20
+ : ["-y", "octopus-blackboard-mcp"];
21
+ const env = { OCTOBOARD_AGENT: agent };
22
+ if (opts.boardDir) {
23
+ env.OCTOBOARD_DIR = opts.boardDir;
24
+ }
25
+ return { command, args, env };
26
+ }
27
+ /** The standard `mcpServers` JSON block used by most clients. */
28
+ function mcpServersJson(spec) {
29
+ return JSON.stringify({ mcpServers: { blackboard: spec } }, null, 2);
30
+ }
31
+ /** Codex uses TOML (`~/.codex/config.toml`). */
32
+ function codexToml(spec) {
33
+ const argsToml = spec.args.map((a) => JSON.stringify(a)).join(", ");
34
+ const envToml = Object.entries(spec.env)
35
+ .map(([k, v]) => `${k} = ${JSON.stringify(v)}`)
36
+ .join("\n");
37
+ return [
38
+ "[mcp_servers.blackboard]",
39
+ `command = ${JSON.stringify(spec.command)}`,
40
+ `args = [${argsToml}]`,
41
+ "",
42
+ "[mcp_servers.blackboard.env]",
43
+ envToml,
44
+ ].join("\n");
45
+ }
46
+ export function mcpConfig(client, opts = {}) {
47
+ const agent = opts.agent ?? (client === "json" ? "claude" : client);
48
+ const spec = serverSpec(agent, opts);
49
+ switch (client) {
50
+ case "claude-code":
51
+ return {
52
+ path: "<project>/.mcp.json (or run: claude mcp add-json)",
53
+ content: mcpServersJson(spec),
54
+ note: "Project-scoped: commit .mcp.json to share the board with your team. Or user-scoped via `claude mcp add`.",
55
+ };
56
+ case "cursor":
57
+ return {
58
+ path: "~/.cursor/mcp.json (or <project>/.cursor/mcp.json)",
59
+ content: mcpServersJson(spec),
60
+ };
61
+ case "vscode":
62
+ return {
63
+ path: "<project>/.vscode/mcp.json",
64
+ content: JSON.stringify({ servers: { blackboard: spec } }, null, 2),
65
+ note: "VS Code uses a top-level `servers` key.",
66
+ };
67
+ case "windsurf":
68
+ return {
69
+ path: "~/.codeium/windsurf/mcp_config.json",
70
+ content: mcpServersJson(spec),
71
+ };
72
+ case "gemini":
73
+ return {
74
+ path: "~/.gemini/settings.json (merge the mcpServers key)",
75
+ content: mcpServersJson(spec),
76
+ };
77
+ case "codex":
78
+ return { path: "~/.codex/config.toml", content: codexToml(spec) };
79
+ case "json":
80
+ default:
81
+ return {
82
+ path: "your client's MCP config (mcpServers block)",
83
+ content: mcpServersJson(spec),
84
+ note: "Standard MCP stdio config — works with any MCP-compatible client.",
85
+ };
86
+ }
87
+ }
88
+ //# sourceMappingURL=mcp-config.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"mcp-config.js","sourceRoot":"","sources":["../src/mcp-config.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAWH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,MAAM;IACN,aAAa;IACb,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,UAAU;CACF,CAAC;AASX,SAAS,UAAU,CAAC,KAAa,EAAE,IAAsB;IACvD,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;IACjD,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU;QAC1B,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;QACnB,CAAC,CAAC,CAAC,IAAI,EAAE,wBAAwB,CAAC,CAAC;IACrC,MAAM,GAAG,GAA2B,EAAE,eAAe,EAAE,KAAK,EAAE,CAAC;IAC/D,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClB,GAAG,CAAC,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC;IACpC,CAAC;IACD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;AAChC,CAAC;AAED,iEAAiE;AACjE,SAAS,cAAc,CAAC,IAAgB;IACtC,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AACvE,CAAC;AAED,gDAAgD;AAChD,SAAS,SAAS,CAAC,IAAgB;IACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpE,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC;SACrC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;SAC9C,IAAI,CAAC,IAAI,CAAC,CAAC;IACd,OAAO;QACL,0BAA0B;QAC1B,aAAa,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;QAC3C,WAAW,QAAQ,GAAG;QACtB,EAAE;QACF,8BAA8B;QAC9B,OAAO;KACR,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC;AAWD,MAAM,UAAU,SAAS,CACvB,MAAiB,EACjB,OAAyB,EAAE;IAE3B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACpE,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACrC,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,aAAa;YAChB,OAAO;gBACL,IAAI,EAAE,oDAAoD;gBAC1D,OAAO,EAAE,cAAc,CAAC,IAAI,CAAC;gBAC7B,IAAI,EAAE,0GAA0G;aACjH,CAAC;QACJ,KAAK,QAAQ;YACX,OAAO;gBACL,IAAI,EAAE,qDAAqD;gBAC3D,OAAO,EAAE,cAAc,CAAC,IAAI,CAAC;aAC9B,CAAC;QACJ,KAAK,QAAQ;YACX,OAAO;gBACL,IAAI,EAAE,4BAA4B;gBAClC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;gBACnE,IAAI,EAAE,yCAAyC;aAChD,CAAC;QACJ,KAAK,UAAU;YACb,OAAO;gBACL,IAAI,EAAE,qCAAqC;gBAC3C,OAAO,EAAE,cAAc,CAAC,IAAI,CAAC;aAC9B,CAAC;QACJ,KAAK,QAAQ;YACX,OAAO;gBACL,IAAI,EAAE,qDAAqD;gBAC3D,OAAO,EAAE,cAAc,CAAC,IAAI,CAAC;aAC9B,CAAC;QACJ,KAAK,OAAO;YACV,OAAO,EAAE,IAAI,EAAE,sBAAsB,EAAE,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;QACpE,KAAK,MAAM,CAAC;QACZ;YACE,OAAO;gBACL,IAAI,EAAE,6CAA6C;gBACnD,OAAO,EAAE,cAAc,CAAC,IAAI,CAAC;gBAC7B,IAAI,EAAE,mEAAmE;aAC1E,CAAC;IACN,CAAC;AACH,CAAC"}
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env node
2
+ export {};
3
+ //# sourceMappingURL=mcp.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"mcp.d.ts","sourceRoot":"","sources":["../src/mcp.ts"],"names":[],"mappings":""}