@hilbras/omnihilbras 3.50.3 → 3.51.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 +60 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,22 +1,69 @@
|
|
|
1
1
|
# @hilbras/omnihilbras
|
|
2
2
|
|
|
3
|
-
The OmniHilbras gateway client
|
|
3
|
+
**The OmniHilbras gateway client.** One part of
|
|
4
|
+
[a larger project](https://github.com/Hilbras/OmniHilbras) — see what this package is *not*, below.
|
|
4
5
|
|
|
5
6
|
```bash
|
|
6
7
|
npm i -g @hilbras/omnihilbras
|
|
7
|
-
omnihilbras
|
|
8
|
-
omnihilbras
|
|
9
|
-
omnihilbras
|
|
10
|
-
omnihilbras
|
|
11
|
-
omnihilbras help # the rest
|
|
8
|
+
omnihilbras status # is a gateway running, and what does it say
|
|
9
|
+
omnihilbras providers # every saved account, and which ones can serve
|
|
10
|
+
omnihilbras test zcode # probe one account, or all of them
|
|
11
|
+
omnihilbras help # the rest
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
`OMNIHILBRAS_GATEWAY_URL`. It does **not** start one: the desktop application and a source checkout both
|
|
16
|
-
do that, and this package is the client for either.
|
|
14
|
+
## What this is, and what it is not
|
|
17
15
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
start; neither is ever printed.
|
|
16
|
+
This package is the **client**: the verbs below, over HTTP, against a gateway on your machine. It has **no
|
|
17
|
+
dependencies** and does not download a runtime.
|
|
21
18
|
|
|
22
|
-
|
|
19
|
+
It **cannot start a server**, and that is not an oversight: a globally installed package has no checkout to
|
|
20
|
+
run. `omnihilbras` with no verb prints the help.
|
|
21
|
+
|
|
22
|
+
| You want | Get it from |
|
|
23
|
+
| --- | --- |
|
|
24
|
+
| The gateway, dashboard, desktop app, providers, routing | [The project](https://github.com/Hilbras/OmniHilbras) — [releases and installers](https://github.com/Hilbras/OmniHilbras/releases/latest) |
|
|
25
|
+
| A command that also **starts** the servers | A checkout: `npm link`, then `omnihilbras setup` |
|
|
26
|
+
| Just the verbs, against a gateway you already run | This package |
|
|
27
|
+
|
|
28
|
+
## Verbs
|
|
29
|
+
|
|
30
|
+
| Verb | What it answers |
|
|
31
|
+
| --- | --- |
|
|
32
|
+
| `setup` | First run: what is missing on this machine, install it (printing each command before running it), install the `omnihilbras` command, start the servers |
|
|
33
|
+
| `doctor` | The same checks as a report that **changes nothing** — safe in a script or on someone else's machine |
|
|
34
|
+
| `status` | Is the gateway up, what version, which providers are unhealthy (`--strict` exits `1`) |
|
|
35
|
+
| `providers` | Every saved account: enabled, priority, credential kind, models, ejection, last error |
|
|
36
|
+
| `models` | The served model ids, grouped by provider prefix |
|
|
37
|
+
| `test` | Probe one account, or every account of a provider |
|
|
38
|
+
| `keys` | Key metadata; `--mint` creates one and prints the secret once |
|
|
39
|
+
| `routing` | Live routing state: failures, ejection, waits, latency, strategy |
|
|
40
|
+
| `logs` | Follow finished requests — model, provider, account, outcome, attempts, error code |
|
|
41
|
+
|
|
42
|
+
Every verb takes **`--json`**, which prints the answer as data and nothing else, so a script never parses a
|
|
43
|
+
table. Exit codes mean something: `0` worked, `1` did not, `2` the command was wrong, `130` interrupted.
|
|
44
|
+
|
|
45
|
+
## Authentication
|
|
46
|
+
|
|
47
|
+
Point it at a gateway with `--gateway <url>` or `OMNIHILBRAS_GATEWAY_URL` (default `127.0.0.1:20138`).
|
|
48
|
+
Management routes accept either:
|
|
49
|
+
|
|
50
|
+
- a public API key — `--api-key <key>` or `OMNIHILBRAS_API_KEY`; or
|
|
51
|
+
- the local dashboard token the gateway writes on start, which is the default when you run it on the same
|
|
52
|
+
machine.
|
|
53
|
+
|
|
54
|
+
Neither is ever printed, echoed in an error, or written anywhere.
|
|
55
|
+
|
|
56
|
+
## A note on the name
|
|
57
|
+
|
|
58
|
+
Versions **before `3.0.0`** under this name are a different program — the previous project, described by its
|
|
59
|
+
own manifest as *"OmniHilbras CLI - Start and manage OmniHilbras server"*, whose `omnihilbras` **did** start a
|
|
60
|
+
server. They are deprecated, because this package is the client and behaves differently on purpose.
|
|
61
|
+
|
|
62
|
+
## Links
|
|
63
|
+
|
|
64
|
+
- [The project](https://github.com/Hilbras/OmniHilbras) · [releases](https://github.com/Hilbras/OmniHilbras/releases/latest)
|
|
65
|
+
- [`docs/CLI.md`](https://github.com/Hilbras/OmniHilbras/blob/main/docs/CLI.md) — the full CLI reference
|
|
66
|
+
- [`docs/INSTALL.md`](https://github.com/Hilbras/OmniHilbras/blob/main/docs/INSTALL.md) — installing and uninstalling, including the command this package installs
|
|
67
|
+
- [`docs/SPEC-SDK.md`](https://github.com/Hilbras/OmniHilbras/blob/main/docs/SPEC-SDK.md) — the gateway's routes and contracts
|
|
68
|
+
|
|
69
|
+
MIT.
|
package/package.json
CHANGED