kiokuko 1.0.0 → 1.0.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.ja.md +28 -7
- package/README.ko.md +28 -7
- package/README.md +28 -7
- package/README.zh-CN.md +28 -7
- package/dist/cli.d.ts +3 -1
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +6 -43
- package/dist/cli.js.map +1 -1
- package/dist/commands/embeddings.d.ts.map +1 -1
- package/dist/commands/embeddings.js +60 -22
- package/dist/commands/embeddings.js.map +1 -1
- package/dist/commands/setup.d.ts +2 -1
- package/dist/commands/setup.d.ts.map +1 -1
- package/dist/commands/setup.js +23 -2
- package/dist/commands/setup.js.map +1 -1
- package/dist/commands/uninstall.d.ts +29 -0
- package/dist/commands/uninstall.d.ts.map +1 -0
- package/dist/commands/uninstall.js +330 -0
- package/dist/commands/uninstall.js.map +1 -0
- package/dist/config/paths.d.ts +1 -0
- package/dist/config/paths.d.ts.map +1 -1
- package/dist/config/paths.js +1 -1
- package/dist/config/paths.js.map +1 -1
- package/dist/embedding/setup-service.d.ts +2 -0
- package/dist/embedding/setup-service.d.ts.map +1 -1
- package/dist/embedding/setup-service.js +32 -9
- package/dist/embedding/setup-service.js.map +1 -1
- package/dist/setup/managed-text.d.ts +2 -0
- package/dist/setup/managed-text.d.ts.map +1 -1
- package/dist/setup/managed-text.js +11 -0
- package/dist/setup/managed-text.js.map +1 -1
- package/dist/setup/render.d.ts +2 -0
- package/dist/setup/render.d.ts.map +1 -1
- package/dist/setup/render.js +17 -1
- package/dist/setup/render.js.map +1 -1
- package/dist/terminal/checkbox.d.ts +17 -0
- package/dist/terminal/checkbox.d.ts.map +1 -0
- package/dist/terminal/checkbox.js +117 -0
- package/dist/terminal/checkbox.js.map +1 -0
- package/dist/uninstall/files.d.ts +34 -0
- package/dist/uninstall/files.d.ts.map +1 -0
- package/dist/uninstall/files.js +123 -0
- package/dist/uninstall/files.js.map +1 -0
- package/dist/uninstall/render.d.ts +9 -0
- package/dist/uninstall/render.d.ts.map +1 -0
- package/dist/uninstall/render.js +132 -0
- package/dist/uninstall/render.js.map +1 -0
- package/docs/breaking-changes-1.0.md +13 -0
- package/docs/cli-contract.md +95 -13
- package/docs/getting-started.ja.md +18 -5
- package/docs/getting-started.md +20 -6
- package/docs/semantic-retrieval.ja.md +5 -3
- package/docs/semantic-retrieval.md +5 -4
- package/package.json +1 -1
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"render.js","sourceRoot":"","sources":["../../src/uninstall/render.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,MAAM,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAEjE,SAAS,MAAM,CAAC,KAAc;IAC5B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,UAAU,CAAC,MAAc,EAAE,QAAiB;IACnD,MAAM,OAAO,GAAG,EAAE,kBAAkB,EAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC,QAAQ,EAAE,CAAC;IAC9E,sBAAsB,CAAC,MAAM,EAAE,OAAO,EAAE,8BAA8B,CAAC,CAAC;IACxE,MAAM,KAAK,GAAY,KAAK,CAAC,MAAM,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;QAAE,MAAM,IAAI,YAAY,CAAC,kBAAkB,EAAE,wCAAwC,CAAC,CAAC;IACzG,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,cAAc,CAAC,MAAc,EAAE,QAA6B;IACnE,OAAO,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE;QAC5D,iBAAiB,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE;KACpG,CAAC,CAAC,CAAC;AACN,CAAC;AAED,uFAAuF;AACvF,MAAM,UAAU,mBAAmB,CAAC,MAAc,EAAE,MAA6B;IAC/E,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,EAAE,MAAM,KAAK,UAAU,CAAC,CAAC;IACvD,MAAM,GAAG,GAAG,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC;IACvD,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1B,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC;IACzC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;QAAE,MAAM,IAAI,YAAY,CAAC,kBAAkB,EAAE,wBAAwB,CAAC,CAAC;IAC3F,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC;QAAE,OAAO,MAAM,CAAC;IACtD,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAC/B,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,CAAC,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;QACtG,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,QAAQ;QACvD,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK;QAC/G,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC;IAC5H,IAAI,CAAC,UAAU,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACxG,wBAAwB,CAAC,MAAM,EAAE,GAAG,MAAM,sEAAsE,CAAC,CAAC;IACpH,CAAC;IACD,sFAAsF;IACtF,MAAM,OAAO,GAAG,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC;IACrG,2EAA2E;IAC3E,MAAM,WAAW,GAAG,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAE,MAAkC,CAAC,GAAG,CAAC,CAAC,CAAE,MAAkC,CAAC,WAAW,CAAC;IACpI,MAAM,aAAa,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5F,MAAM,IAAI,GAAG,oBAAoB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7E,MAAM,KAAK,GAAG,MAAM,KAAK,QAAQ;QAC/B,CAAC,CAAC,kBAAkB,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,OAAO;QACtD,CAAC,CAAC,oBAAoB,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC;IAC3D,OAAO,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC;AAChD,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,qBAAqB,CAAC,MAAc;IAClD,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IACvC,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5D,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,MAAM,CAAC;QAC9C,MAAM,IAAI,YAAY,CAAC,kBAAkB,EAAE,2CAA2C,CAAC,CAAC;IAC1F,CAAC;IACD,MAAM,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IAC3D,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC;IACzC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;QAAE,MAAM,IAAI,YAAY,CAAC,kBAAkB,EAAE,+BAA+B,CAAC,CAAC;IACjG,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IAC5C,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC;IACxC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,aAAa,EAAE,IAAI,EAAE,KAAK,qBAAqB,EAAE,CAAC;QAC9E,wBAAwB,CAAC,QAAQ,EAAE,+CAA+C,CAAC,CAAC;IACtF,CAAC;IACD,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC1B,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IACxE,MAAM,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC9G,OAAO,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC;AACpH,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,mBAAmB,CAAC,MAAc;IAChD,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,mCAAmC,EAAE,EAAE,CAAC,CAAC;IACxE,OAAO,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC;AACpD,CAAC;AAED,SAAS,aAAa,CAAC,KAA8B,EAAE,MAA0B;IAC/E,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,uBAAuB;QAAE,OAAO,IAAI,CAAC;IACnH,OAAO,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ;WAC/D,IAAI,MAAM,CAAC,0BAA0B,MAAM,kBAAkB,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAC/F,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,iBAAiB,CAAC,MAAc,EAAE,MAA0B;IAC1E,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACvC,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC;IAC5C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,MAAM,IAAI,YAAY,CAAC,kBAAkB,EAAE,yBAAyB,CAAC,CAAC;IAC/F,IAAI,OAAO,GAAG,MAAM,CAAC;IACrB,KAAK,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE,kBAAkB,CAAC,EAAE,CAAC;QACjD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACjC,IAAI,MAAM,KAAK,SAAS;YAAE,SAAS;QACnC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YAAE,MAAM,IAAI,YAAY,CAAC,kBAAkB,EAAE,4BAA4B,CAAC,CAAC;QACrG,KAAK,IAAI,UAAU,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,UAAU,IAAI,CAAC,EAAE,UAAU,EAAE,EAAE,CAAC;YACvE,MAAM,KAAK,GAAY,MAAM,CAAC,UAAU,CAAC,CAAC;YAC1C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;gBAAE,MAAM,IAAI,YAAY,CAAC,kBAAkB,EAAE,2BAA2B,CAAC,CAAC;YAC3H,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAgB,EAAE,KAAa,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;YAC5K,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;gBAAE,SAAS;YACpC,IAAI,QAAQ,CAAC,MAAM,KAAK,KAAK,CAAC,KAAK,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,OAAO,IAAI,GAAG,KAAK,SAAS,CAAC,EAAE,CAAC;gBACpH,OAAO,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC;YAClE,CAAC;iBAAM,CAAC;gBACN,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,OAAO,EAAE;oBAAE,OAAO,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;YAC1H,CAAC;QACH,CAAC;QACD,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,KAAgC,CAAC;QACjF,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;IAClI,CAAC;IACD,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC7C,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IACvH,OAAO,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,KAAK,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC;AAC1G,CAAC"}
|
|
@@ -4,6 +4,13 @@ Kiokuko 1.0 removes enno-oduno, zenki, and goki. There is no replacement
|
|
|
4
4
|
orchestrator. Akinator intake, memory, Skill discovery, Curator, and the normal
|
|
5
5
|
CLI, MCP, and Web interfaces remain available.
|
|
6
6
|
|
|
7
|
+
## Setup defaults
|
|
8
|
+
|
|
9
|
+
`kiokuko setup` now also installs and configures local semantic retrieval. For the
|
|
10
|
+
previous client-only behavior, use `kiokuko setup --no-embeddings`. Existing
|
|
11
|
+
embedding settings and models are preserved when this flag is used.
|
|
12
|
+
`kiokuko embeddings setup` remains a compatible entrypoint for the same setup flow.
|
|
13
|
+
|
|
7
14
|
## Database
|
|
8
15
|
|
|
9
16
|
Older databases cannot be upgraded or opened by 1.0. They are rejected without
|
|
@@ -45,6 +52,12 @@ new package major. Removed commands and tools fail as unsupported operations.
|
|
|
45
52
|
|
|
46
53
|
## Remove previously installed automation
|
|
47
54
|
|
|
55
|
+
To remove Kiokuko completely, including these retired integrations, use
|
|
56
|
+
[`kiokuko uninstall`](cli-contract.md#uninstall) and select all four agents,
|
|
57
|
+
or use `kiokuko uninstall --all`. Complete cleanup also deletes stored memory
|
|
58
|
+
and embedding models. Selecting only some agents retains shared data and the
|
|
59
|
+
npm package. The manual steps below are for retaining Kiokuko 1.0.
|
|
60
|
+
|
|
48
61
|
Stop affected clients before editing their configuration. Remove only these
|
|
49
62
|
old Kiokuko entries, preserving other hooks and user content:
|
|
50
63
|
|
package/docs/cli-contract.md
CHANGED
|
@@ -1,24 +1,29 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Setup and embedding CLI contract
|
|
2
2
|
|
|
3
|
-
The default
|
|
3
|
+
The npm package stays lightweight. The default setup command configures clients,
|
|
4
|
+
installs the pinned optional runtime when needed, downloads the verified local
|
|
5
|
+
model, and enables semantic retrieval:
|
|
4
6
|
|
|
5
7
|
```bash
|
|
6
8
|
npm install --global @askdkc/kiokuko
|
|
7
9
|
kiokuko setup
|
|
8
10
|
```
|
|
9
11
|
|
|
10
|
-
|
|
11
|
-
optional local semantic runtime. To opt into local semantic retrieval, run the
|
|
12
|
-
following command. It installs the pinned optional dependencies when needed,
|
|
13
|
-
then applies the same client configuration flow as `kiokuko setup`: managed
|
|
14
|
-
MCP blocks are updated and registered-project instructions are refreshed.
|
|
15
|
-
Unmanaged MCP identities require interactive confirmation before replacement;
|
|
16
|
-
non-interactive or `--dry-run --json` runs fail closed without changing them.
|
|
12
|
+
To configure clients without embedding setup:
|
|
17
13
|
|
|
18
14
|
```bash
|
|
19
|
-
kiokuko embeddings
|
|
15
|
+
kiokuko setup --no-embeddings
|
|
20
16
|
```
|
|
21
17
|
|
|
18
|
+
`--no-embeddings` skips runtime checks and installation, model download, and
|
|
19
|
+
embedding activation/generation. It preserves existing embedding settings and
|
|
20
|
+
models; it does not disable an active semantic profile. `kiokuko embeddings setup`
|
|
21
|
+
is a compatibility entrypoint for the same implementation and accepts the same flags.
|
|
22
|
+
|
|
23
|
+
Both paths update managed MCP blocks and refresh registered-project instructions.
|
|
24
|
+
Unmanaged MCP identities require interactive confirmation before replacement;
|
|
25
|
+
non-interactive or `--dry-run --json` runs fail closed without changing them.
|
|
26
|
+
|
|
22
27
|
`boolean@3.2.0` is an upstream transitive dependency of the Transformers.js
|
|
23
28
|
runtime. It is not a Kiokuko dependency and is not present in the lightweight
|
|
24
29
|
install. On Linux, the first automatic dependency installation uses sudo
|
|
@@ -26,14 +31,91 @@ through npm. On macOS it installs into Kiokuko's package-local `node_modules`
|
|
|
26
31
|
instead of the shared npm global prefix; other platforms invoke npm directly.
|
|
27
32
|
Do not persist npm script permissions or use `--dangerously-allow-all-scripts`.
|
|
28
33
|
|
|
29
|
-
`kiokuko
|
|
34
|
+
`kiokuko setup` installs the pinned `local-small` preset without a
|
|
30
35
|
separate confirmation flag. Automation uses:
|
|
31
36
|
|
|
32
37
|
```bash
|
|
33
|
-
kiokuko
|
|
38
|
+
kiokuko setup --preset local-small --json
|
|
34
39
|
```
|
|
35
40
|
|
|
36
41
|
`--dry-run` performs no download, model load, database write, or filesystem
|
|
37
42
|
mutation. `--offline` uses only an existing verified installation. `--replace`
|
|
38
43
|
allows switching profiles. `status --json` reports bounded coverage and model
|
|
39
|
-
state
|
|
44
|
+
state. Repeating setup reuses verified model files.
|
|
45
|
+
|
|
46
|
+
JSON keeps the invoked operation name (`setup` or `embeddings.setup`) and includes
|
|
47
|
+
`embeddingsSkipped`. Normal setup includes the client setup fields, semantic result,
|
|
48
|
+
and `projectSetup`; `--no-embeddings` returns the client setup result without a
|
|
49
|
+
semantic result. Dry-run reads an existing database without initializing or upgrading it.
|
|
50
|
+
|
|
51
|
+
## Uninstall
|
|
52
|
+
|
|
53
|
+
Stop clients using Kiokuko and any foreground `kiokuko serve` process before cleanup:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
kiokuko uninstall --dry-run
|
|
57
|
+
kiokuko uninstall
|
|
58
|
+
# After selecting all agents and completing cleanup:
|
|
59
|
+
npm uninstall --global kiokuko
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
On a terminal, `uninstall` shows Codex, OpenCode, Claude Code, and Hermes Agent
|
|
63
|
+
with no initial selections. Up/Down moves focus, Space toggles a choice, Enter
|
|
64
|
+
submits, and Esc/Ctrl+C cancels without changing files. Number keys 1–4 also toggle
|
|
65
|
+
choices. Submitting an empty selection changes nothing. Selecting only some agents
|
|
66
|
+
removes their managed integrations and Skills, retaining unchecked agents and
|
|
67
|
+
shared memory, models, runtime files, and project bindings. Keep the npm package
|
|
68
|
+
after partial removal. Selecting all four agents performs complete cleanup.
|
|
69
|
+
|
|
70
|
+
For explicit selection or scripts:
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
kiokuko uninstall --clients opencode,claude --dry-run
|
|
74
|
+
kiokuko uninstall --clients opencode,claude
|
|
75
|
+
# Complete cleanup without a selection prompt:
|
|
76
|
+
kiokuko uninstall --all --dry-run
|
|
77
|
+
kiokuko uninstall --all
|
|
78
|
+
npm uninstall --global kiokuko
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
`--clients` and `--all` are mutually exclusive. Noninteractive and `--json`
|
|
82
|
+
deletion require one of them. A noninteractive or JSON `--dry-run` without either
|
|
83
|
+
option previews all agents without writing files.
|
|
84
|
+
|
|
85
|
+
Complete cleanup deletes all memory in the selected database, its sidecars, downloaded
|
|
86
|
+
embedding models, and runtime files. It removes Kiokuko MCP entries and managed
|
|
87
|
+
instruction blocks for Codex, OpenCode, Claude Code, and every Hermes profile
|
|
88
|
+
under the configured Hermes root. Marked standard Skills, including retired
|
|
89
|
+
references and the old orchestration Skill, are removed. Retired managed
|
|
90
|
+
OpenCode plugins and Kiokuko Stop/UserPromptSubmit hook handlers are also removed.
|
|
91
|
+
|
|
92
|
+
The database registry supplies project locations, including custom agent-file
|
|
93
|
+
paths from `.kiokuko.json`. Uninstall removes the managed instruction block,
|
|
94
|
+
the binding, and its exact `.gitignore` entry. Shared files retain other content;
|
|
95
|
+
standalone generated files and empty owned directories are deleted. Unmarked
|
|
96
|
+
Skill files and other files in a shared data directory are reported as preserved.
|
|
97
|
+
User-chosen backup/export destinations are not tracked and are retained.
|
|
98
|
+
MCP entries that cannot be identified as Kiokuko-managed are excluded from
|
|
99
|
+
uninstall: their configuration files are retained unchanged and reported as
|
|
100
|
+
`preserved` with a reason. Cleanup of other artifacts continues, including the
|
|
101
|
+
final npm removal command. Invalid configuration syntax still rejects the plan.
|
|
102
|
+
|
|
103
|
+
Use the same `KIOKUKO_DATA_DIR`, `CODEX_HOME`, `CLAUDE_CONFIG_DIR`, XDG variables,
|
|
104
|
+
and `HERMES_HOME` as setup. Uninstall does not search the home directory or discover
|
|
105
|
+
previous environment overrides. Missing registered project roots are reported;
|
|
106
|
+
unregistered copies and projects from an unavailable/deleted database cannot be
|
|
107
|
+
discovered automatically.
|
|
108
|
+
|
|
109
|
+
`--dry-run` validates the plan without changing files; `--json` emits the normal
|
|
110
|
+
envelope with `clients`, `scope` (`all`, `clients`, or `none`), `files`,
|
|
111
|
+
`missingProjects`, `dryRun`, and `npmCommand`. `npmCommand` is `null` for partial
|
|
112
|
+
or empty selections. A live instance,
|
|
113
|
+
embedding setup lock, malformed configuration, mismatched project binding, or
|
|
114
|
+
symbolic link rejects cleanup. The full plan is validated before mutation.
|
|
115
|
+
Filesystem failures during application return `PARTIAL_FAILURE` with completed
|
|
116
|
+
paths and the cause. Changes already applied are not rolled back; keep the npm
|
|
117
|
+
package, resolve the problem, and rerun. The database is deleted after client and
|
|
118
|
+
project cleanup, so a failed configuration edit retains the registry for retry.
|
|
119
|
+
|
|
120
|
+
After complete cleanup, the human success output ends with `npm uninstall --global kiokuko`. Uninstall
|
|
121
|
+
does not execute npm, remove the running package, or request sudo itself.
|
|
@@ -9,7 +9,19 @@ npm install --global @askdkc/kiokuko
|
|
|
9
9
|
kiokuko setup
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
`setup`はクライアント設定とローカルsemantic検索の導入を行います。
|
|
13
|
+
埋め込みランタイムの導入・モデル取得・埋め込み生成を省略する場合:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
kiokuko setup --no-embeddings
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
既存の埋め込み設定とモデルは保持します。設定済みsemantic検索を無効化するフラグではありません。
|
|
20
|
+
ほかに`--no-standard-skills`、`--skill-discovery off|official|community`、`--dry-run --json`が使えます。
|
|
21
|
+
|
|
22
|
+
Terminalでは、↑↓でエージェント間を移動し、Spaceでチェックを切り替え、Enterで確定します。
|
|
23
|
+
数字キー1〜4でも各エージェントのチェックを切り替えられます。検出済みのエージェントは選択済みで、複数選択できます。
|
|
24
|
+
EscまたはCtrl+Cで選択を中断します。自動実行では`--clients codex,opencode`のように対象を指定してください。
|
|
13
25
|
|
|
14
26
|
Codexでは次のmanaged blockを所有します。
|
|
15
27
|
|
|
@@ -30,12 +42,13 @@ required = true
|
|
|
30
42
|
|
|
31
43
|
## Embeddings
|
|
32
44
|
|
|
33
|
-
`kiokuko
|
|
34
|
-
登録済みプロジェクトのinstructions
|
|
45
|
+
`kiokuko setup`は固定semantic runtimeの導入とclient設定(conflict確認、managed MCP更新、
|
|
46
|
+
登録済みプロジェクトのinstructions更新)を実行します。`kiokuko embeddings setup`は同じ実装への
|
|
47
|
+
互換入口で、こちらでも`--no-embeddings`を指定できます。
|
|
35
48
|
|
|
36
49
|
```bash
|
|
37
|
-
kiokuko
|
|
38
|
-
kiokuko
|
|
50
|
+
kiokuko setup --clients codex
|
|
51
|
+
kiokuko setup --preset local-small --offline
|
|
39
52
|
kiokuko embeddings status --json
|
|
40
53
|
```
|
|
41
54
|
|
package/docs/getting-started.md
CHANGED
|
@@ -9,7 +9,20 @@ npm install --global @askdkc/kiokuko
|
|
|
9
9
|
kiokuko setup
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
`setup` configures clients and local semantic retrieval by default. To skip the
|
|
13
|
+
embedding runtime, model download, and embedding generation:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
kiokuko setup --no-embeddings
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Existing embedding settings and models are preserved. This flag does not disable
|
|
20
|
+
a previously configured semantic profile. Other setup flags include
|
|
21
|
+
`--no-standard-skills`, `--skill-discovery off|official|community`, and `--dry-run --json`.
|
|
22
|
+
|
|
23
|
+
In a terminal, use Up/Down to move, Space to toggle a client, and Enter to confirm.
|
|
24
|
+
Number keys 1–4 also toggle clients. Detected clients start checked; multiple clients can be selected.
|
|
25
|
+
Press Esc or Ctrl+C to cancel selection. For automation, specify clients with `--clients codex,opencode`.
|
|
13
26
|
|
|
14
27
|
For Codex, setup owns one exact managed block:
|
|
15
28
|
|
|
@@ -32,13 +45,14 @@ database, and Codex MCP health; doctor is read-only.
|
|
|
32
45
|
|
|
33
46
|
## Embeddings setup
|
|
34
47
|
|
|
35
|
-
`kiokuko
|
|
36
|
-
|
|
37
|
-
|
|
48
|
+
`kiokuko setup` installs the pinned local semantic runtime and runs client
|
|
49
|
+
configuration, including conflict confirmation, managed MCP replacement, and
|
|
50
|
+
registered-project instruction refresh. `kiokuko embeddings setup` is a compatibility
|
|
51
|
+
entrypoint for the same implementation and also accepts `--no-embeddings`.
|
|
38
52
|
|
|
39
53
|
```bash
|
|
40
|
-
kiokuko
|
|
41
|
-
kiokuko
|
|
54
|
+
kiokuko setup --clients codex
|
|
55
|
+
kiokuko setup --preset local-small --offline
|
|
42
56
|
kiokuko embeddings status --json
|
|
43
57
|
```
|
|
44
58
|
|
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
# Semantic retrieval
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
`kiokuko setup`でlexical検索とlocal `local-small` semantic profileを設定します。
|
|
4
|
+
埋め込みの導入を省略する場合は`kiokuko setup --no-embeddings`を使います。既存の埋め込み設定は保持します。
|
|
5
|
+
`kiokuko embeddings setup`も互換入口として利用できます。
|
|
4
6
|
|
|
5
7
|
```bash
|
|
6
|
-
kiokuko
|
|
8
|
+
kiokuko setup
|
|
7
9
|
kiokuko embeddings status --json
|
|
8
|
-
kiokuko
|
|
10
|
+
kiokuko setup --offline
|
|
9
11
|
```
|
|
10
12
|
|
|
11
13
|
固定runtimeを導入し、load前にartifactを検証します。`--offline`は検証済みlocal installationを要求し、`--dry-run`はdownload・書き込み・profile変更を行いません。
|
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
# Semantic retrieval
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
`kiokuko setup` configures lexical retrieval and the local `local-small` semantic
|
|
4
|
+
profile. Use `kiokuko setup --no-embeddings` to skip embedding setup while preserving
|
|
5
|
+
any existing embedding settings. `kiokuko embeddings setup` remains a compatibility entrypoint.
|
|
5
6
|
|
|
6
7
|
```bash
|
|
7
|
-
kiokuko
|
|
8
|
+
kiokuko setup
|
|
8
9
|
kiokuko embeddings status --json
|
|
9
|
-
kiokuko
|
|
10
|
+
kiokuko setup --offline
|
|
10
11
|
```
|
|
11
12
|
|
|
12
13
|
Setup installs only the pinned runtime and verifies every artifact before loading
|