@ringko-ai/rkh 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -15
- package/bin/{rkh.mjs → ringko.mjs} +436 -125
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,28 +1,32 @@
|
|
|
1
|
-
# RingKo
|
|
1
|
+
# RingKo Harness
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
RingKo is a provider-neutral agent harness. The `ringko` command offers two
|
|
4
|
+
interface styles: an interactive terminal UI (plain `ringko`, the default) and a
|
|
5
|
+
browser UI (`ringko serve`, which prints the URL to open). Both run the same tool
|
|
6
|
+
registry, the same approval gate and the same event-sourced session log.
|
|
4
7
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
The `rkh` executable requires Bun on your PATH. You can also use
|
|
10
|
-
`bunx @ringko-ai/rkh tui`, or run `npx @ringko-ai/rkh help` to list commands.
|
|
11
|
-
|
|
12
|
-
For a global installation:
|
|
8
|
+
`@ringko-ai/rkh` installs that command globally. The executable is a Bun bundle, so
|
|
9
|
+
Node.js 24+ **and** [Bun](https://bun.sh/) 1.2+ must be on `PATH` — Bun is not
|
|
10
|
+
optional.
|
|
13
11
|
|
|
14
12
|
```sh
|
|
15
13
|
npm install -g @ringko-ai/rkh
|
|
16
|
-
|
|
14
|
+
ringko # terminal interface (default)
|
|
15
|
+
ringko serve # local backend + browser interface, prints its URL
|
|
17
16
|
```
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
`ringko help` lists every command. Without a global install, `npx @ringko-ai/rkh tui`
|
|
19
|
+
and `bunx @ringko-ai/rkh tui` run the same CLI.
|
|
20
|
+
|
|
21
|
+
Prerelease versions publish under the `next` dist-tag: `npm install -g @ringko-ai/rkh@next`.
|
|
20
22
|
|
|
21
23
|
This package bundles the CLI, built-in model providers and the WebUI assets.
|
|
22
24
|
The browser's interactive terminal uses Node.js and the `node-pty` dependency.
|
|
23
|
-
Custom provider modules configured by the host are loaded separately at runtime.
|
|
24
|
-
|
|
25
|
-
|
|
25
|
+
Custom provider modules configured by the host are loaded separately at runtime.
|
|
26
|
+
The package installs the `ringko` command; the standalone platform binaries
|
|
27
|
+
use the same name. For source development and standalone binaries, see the
|
|
28
|
+
[repository](https://github.com/RingKoAI/ringko-harness); the Chinese README is
|
|
29
|
+
[README.zh-CN.md](https://github.com/RingKoAI/ringko-harness/blob/main/README.zh-CN.md).
|
|
26
30
|
|
|
27
31
|
## Automatic npm releases
|
|
28
32
|
|