mslxdff 0.1.55 → 0.1.56

package/README.md

@@ -1,162 +1,3 @@
 # mslxdff
 
-测试项目，请勿使用。
-
-Zero runtime dependencies: Node ≥ 20, built-in `node:http`, `node:crypto`, `node:test`.
-
-## What it does
-
-- `POST /v1/chat/completions` — forwards your OpenAI-format request to the upstream (with reasoning-content injection for thinking-mode DeepSeek/Kimi models), streams SSE back chunk-by-chunk, or passes through JSON for non-streaming calls.
-- `GET /v1/models` — the ~7 free models (`*-free` plus `big-pickle`), filtered from the full upstream list, cached and refreshed in the background every 2 hours.
-- `GET /health` — public liveness check.
-
-### `auto` model
-
-Omitting `model` (or passing `"auto"`) picks a free model automatically, DeepSeek first. On an upstream error the next candidate is tried in the same request; each model's last-error timestamp is recorded (persisted in the state file) so the most reliably-available model is preferred next time.
-
-### Fallback for a specific model
-
-Pointing at a specific model (e.g. `deepseek-v4-flash-free`) still gets failover: if that model errors, the request automatically falls through to the next free model so your task isn't interrupted, and the error is recorded. The model enters a cooldown window (default 60s, `MSLXDFF_MODEL_COOLDOWN_MS`); during cooldown the backup models are used directly, and afterwards your model is tried again — once it succeeds it keeps being used until it errors again.
-
-## Install & run
-
-```
-npm install      # no deps actually fetched; just links the bin
-mslxdff          # or: node bin/mslxdff.js
-```
-
-First run generates a bearer token, writes it to the state file, and prints it:
-
-```
-mslxdff listening on http://localhost:8989
-auth token: 9b5de021e914...
-endpoint:   http://localhost:8989/v1
-```
-
-### Port
-
-Default port is **8989**. Persist a different port (and hot-restart the daemon onto it if one is running):
-
-```
-mslxdff -port 8000     # set port to 8000; restarts the daemon on 8000
-mslxdff -d             # next starts reuse the persisted port (8000)
-```
-
-Priority: `-port` arg > persisted port > `PORT` env > default `8989`.
-
-### Daemon (background, stays resident)
-
-Just run `mslxdff` (no args): if no daemon is running yet, it **starts a background
-daemon and exits** — the command never holds your terminal, so `npx mslxdff` works
-the same way. If a daemon is already up, the bare command shows status + help.
-
-```
-mslxdff        # starts the background daemon (if none running); exits immediately
-mslxdff -d     # same, explicit
-mslxdff -stop  # stop it
-```
-
-Logs go to `~/.config/mslxdff/daemon.log`, the daemon pid to `daemon.pid` (both overridable via `MSLXDFF_DAEMON_DIR`). The daemon keeps running after your shell exits.
-
-### Status
-
-Running `mslxdff` with no args shows a status panel when a daemon is already up: joined groups with their members, failover targets, the free model list, the last 5 calls (model/status/latency), and the most recent error (`mslxdff -status` for status only, `mslxdff -help` for the full command reference). Call and error history are stored as JSON-lines at `calls.log` / `errors.log` in the state dir.
-
-```
-$ mslxdff -status
-mslxdff v0.1.2
-daemon:    running (pid 12345)
-endpoint:  http://localhost:8989/v1
-log dir:   C:/Users/you/.config/mslxdff
-
-models (7 free):
-  big-pickle
-  deepseek-v4-flash-free
-  ...
-
-recent calls:
-  08-03 12:00:03  deepseek-v4-flash-free  200  812ms
-  ...
-
-last error:
-  08-03 11:59:58  deepseek-v4-flash-free  429  upstream 429
-```
-
-### Update
-
-```
-mslxdff -update    # install the latest published version; restarts a running daemon
-```
-
-### Groups (join several machines by name)
-
-Run mslxdff on several machines (e.g. locally + a VPS) and join them into a named group — **the group name is the password**. When the local upstream fails for a model, the request is forwarded to a group member running the **same model** — your task keeps the model it asked for, just served from another machine with its own upstream quota.
-
-```
-# on the leader machine B (must be reachable from the others):
-mslxdff -creategroup mygroup        # group name IS the password, no address needed
-
-# on machine A (and C, D, …) — give the leader's host; your own address is auto-registered:
-mslxdff -addtogroup <B-ip> mygroup
-```
-
-- Anyone who knows the group name can join — pick something unguessable, like `mygroup@mslxd-7f3k`. The leader's first joiner seeds the leader's own entry from the address it connects from, so `-creategroup` takes no address argument (default port 8989; `-addtogroup` also accepts `host:port`).
-- Joining registers your node with the leader (membership is keyed by your bearer token) and immediately pulls the member list into local failover targets.
-- Membership is persisted and re-synced on every start + every `MSLXDFF_GROUP_SYNC_MS` (default 60s), so a newly joined machine becomes a failover target on all nodes automatically.
-- Local-first: every request tries the local upstream before any group member. On local failure, members are tried round-robin for the same model; a member that just failed is skipped for `MSLXDFF_PEER_COOLDOWN_MS` (default 30s).
-- Forwarded requests carry a hop limit (`MSLXDFF_MAX_HOPS`, default 3) to prevent forwarding loops, and a model-lock so the member doesn't switch models. A→B→C chaining works as long as each member knows the others.
-- Wrong group names (or wrong tokens) are counted per source IP: `MSLXDFF_BAN_THRESHOLD` (default 5) failures ban the IP for `MSLXDFF_BAN_WINDOW_MS` (default 48h). `mslxdff -resetban [ip]` clears bans (all, or one IP).
-- `mslxdff -group sync` pulls once manually; `mslxdff -group leave <name>` detaches from a group and clears its members; `mslxdff -group list` shows groups. See `docs/adr/0005-peer-mesh.md`.
-
-```
-mslxdff -showtoken      # print the current token (creates one on first use)
-mslxdff -refresh-token  # rotate it (prints the new token, does not start the server)
-```
-
-## Client configuration
-
-Point any OpenAI-compatible client at the endpoint with the token:
-
-```
-Endpoint:   http://localhost:8989/v1
-API Key:    <the bearer token>      (sent as Authorization: Bearer <token>)
-Model:      oc/deepseek-v4-flash-free   (the oc/ prefix is optional)
-```
-
-<x-model list>
-
-```
-$ curl -H "Authorization: Bearer <token>" http://localhost:8989/v1/models
-{"object":"list","data":[{"id":"big-pickle",...},{"id":"deepseek-v4-flash-free",...}, ...]}
-</x-model list>
-
-## Environment variables
-
-| Variable | Default | Purpose |
-|---|---|---|
-| `PORT` | `8989` | listen port (used when no `-port` arg and no persisted port) |
-| `MSLXDFF_STATE_FILE` | `~/.config/mslxdff/state.json` | token/port state file (mode 0600) |
-| `MSLXDFF_DAEMON_DIR` | `~/.config/mslxdff` | daemon pid + log directory |
-| `UPSTREAM_BASE_URL` | `https://opencode.ai` | upstream base |
-| `UPSTREAM_AUTH_TOKEN` | `public` | upstream `Authorization: Bearer <…>` value |
-| `UPSTREAM_CONNECT_TIMEOUT_MS` | `30000` | upstream connect timeout |
-| `LOG_LEVEL` | `info` | (reserved) |
-| `MODELS_REFRESH_MS` | `7200000` | background model-list refresh interval (2h) |
-| `MSLXDFF_MODEL_COOLDOWN_MS` | `60000` | fallback cooldown after a model error |
-| `MSLXDFF_PEER_COOLDOWN_MS` | `30000` | peer failover cooldown |
-| `MSLXDFF_GROUP_SYNC_MS` | `60000` | group membership sync interval |
-| `MSLXDFF_MAX_HOPS` | `3` | max peer-forwarding depth |
-| `MSLXDFF_BAN_THRESHOLD` | `5` | failed joins before an IP is banned |
-| `MSLXDFF_BAN_WINDOW_MS` | `172800000` | ban duration after too many join failures (48h) |
-
-## Clients
-
-Point your OpenAI client at `http://<host>:8989/v1` (or the equivalent config seen above). Works for streaming and non-streaming chat completions.
-
-## Development
-
-```
-npm test        # node --test, no network access
-```
-
-The reference implementation is 9Router v0.5.45 (`/root/9router`); see `CLAUDE.md`, `CONTEXT.md`, and `docs/adr/` for the contract and the decisions behind it.
+测试项目，请勿使用