aweshare 0.2.6 → 0.2.8

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 (3) hide show
  1. package/LICENSE +32 -21
  2. package/README.md +34 -11
  3. package/package.json +2 -2
package/LICENSE CHANGED
@@ -1,21 +1,32 @@
1
- MIT License
2
-
3
- Copyright (c) 2026 aweshare contributors
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ aweshare Proprietary License
2
+ Copyright (c) 2026 aweshare contributors. All rights reserved.
3
+
4
+ 1. Grant of use. You may download, install, run, and use the software
5
+ (including the npm package, Docker image, and any binaries) for your
6
+ personal or internal business purposes, and modify it for your own use.
7
+
8
+ 2. No redistribution. You may not redistribute, sublicense, publish, sell,
9
+ resell, or provide the software or any derivative of it as a product or
10
+ hosted service to third parties, in source or compiled form.
11
+
12
+ 3. No source disclosure obligation. The copyright holder is not obligated
13
+ to make source code available. Source code distributed separately
14
+ (if ever) remains under this license.
15
+
16
+ 4. Notices. You may not remove or alter copyright, license, or attribution
17
+ notices contained in the software.
18
+
19
+ 5. No warranty. The software is provided "as is", without warranty of any
20
+ kind, express or implied. In no event shall the authors or contributors
21
+ be liable for any damages arising out of the use of the software.
22
+
23
+ 6. Termination. Any breach of this license terminates your right to use
24
+ the software with immediate effect.
25
+
26
+ For licensing exceptions (e.g. commercial licensing), contact the
27
+ copyright holder.
28
+
29
+ ---
30
+
31
+ The aweshare public documentation repository (wehuman01/aweshare) contains
32
+ documentation only; the software itself is licensed under the terms above.
package/README.md CHANGED
@@ -14,9 +14,9 @@
14
14
  <a href="https://ko-fi.com/mugpeng"><img src="https://img.shields.io/badge/Ko--fi-Buy%20me%20a%20coffee-FF5E5B?style=flat-square&logo=ko-fi&logoColor=white" alt="Ko-fi"></a>
15
15
  </p>
16
16
  <p>
17
- <a href="https://github.com/wehuman01/aweshare-source/releases"><img src="https://img.shields.io/badge/version-0.2.6-7C3AED?style=flat-square" alt="Version"></a>
17
+ <a href="https://github.com/wehuman01/aweshare-source/releases"><img src="https://img.shields.io/badge/version-0.2.8-7C3AED?style=flat-square" alt="Version"></a>
18
18
  <a href="https://github.com/wehuman01/aweshare"><img src="https://img.shields.io/badge/node-%E2%89%A522-0EA5E9?style=flat-square" alt="Node"></a>
19
- <a href="https://github.com/wehuman01/aweshare/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-22C55E?style=flat-square" alt="License"></a>
19
+ <a href="https://github.com/wehuman01/aweshare/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-proprietary-E34F26?style=flat-square" alt="License"></a>
20
20
  <a href="https://www.npmjs.com/package/aweshare"><img src="https://img.shields.io/badge/npm-aweshare-7C3AED?style=flat-square" alt="npm package"></a>
21
21
  </p>
22
22
  <p>
@@ -30,7 +30,7 @@
30
30
  </p>
31
31
  </div>
32
32
 
33
- Producers run a lightweight agent on their own machine and share local Ollama/vLLM or **authorized** OpenAI/Anthropic backends. Upstream API keys live only on the producer's device and are injected by the local agent at forwarding time. Consumers point a standard OpenAI/Anthropic SDK at the hub and call models by `namespace/alias` — exactly like using any other model vendor.
33
+ > Producers run a lightweight agent on their own machine and share local Ollama/vLLM or **authorized** OpenAI/Anthropic backends. Upstream API keys live only on the producer's device and are injected by the local agent at forwarding time. Consumers point a standard OpenAI/Anthropic SDK at the hub and call models by `namespace/alias` — exactly like using any other model vendor.
34
34
 
35
35
  ```
36
36
  Consumer (standard SDK, zero changes) Producer side
@@ -62,7 +62,7 @@ Consumer (standard SDK, zero changes) Producer side
62
62
  - aweshare is relay software: it cannot and does not judge whether you are allowed to share a given upstream key or subscription — that question is between you and the upstream provider. Being able to call an API yourself does not mean you may resell or re-provide it to third parties.
63
63
  - Before sharing anything, read the upstream's terms (account rules, subscription and seat limits, forwarding, commercial-use clauses). Sharing a personal-subscription key — coding plans included — with third parties likely violates those terms; self-hosted open models have no such issue. **When in doubt, don't share.**
64
64
  - The producer bears the consequences of sharing (key revocation, account suspension or termination by the upstream). The hub operator is responsible for operating the hub lawfully and for informing consumers of the plaintext-transit boundary above.
65
- - The software is provided "as is" under the [MIT license](./LICENSE), without warranty of any kind. The authors and contributors are not liable for how aweshare is used or for any damage arising from sharing access through it.
65
+ - The software is provided "as is" under the [proprietary license](./LICENSE) — free to use and self-host, no redistribution — without warranty of any kind. The authors and contributors are not liable for how aweshare is used or for any damage arising from sharing access through it.
66
66
 
67
67
  ## Quickstart
68
68
 
@@ -83,7 +83,7 @@ aweshare hub serve # listens on :8787 (put Caddy/nginx TLS in front)
83
83
  ```bash
84
84
  docker run -d --name aweshare-hub --restart unless-stopped \
85
85
  -p 127.0.0.1:8787:8787 -v "$PWD/data:/data" ghcr.io/wehuman01/aweshare:latest
86
- docker exec aweshare-hub node apps/hub/dist/cli.js init # first run: prints the admin token, save it
86
+ docker exec aweshare-hub aweshare hub init # first run: prints the admin token, save it
87
87
  ```
88
88
 
89
89
  Then issue tokens (admin token in hand):
@@ -93,6 +93,14 @@ aweshare hub token issue --role producer --name peng # → asp_..., give to
93
93
  aweshare hub token issue --role consumer --name alice # → asc_..., give to the consumer
94
94
  ```
95
95
 
96
+ Three token roles, one per party:
97
+
98
+ | Role | Who holds it | How it's used |
99
+ |---|---|---|
100
+ | `admin` | hub operator (you only) | management commands: `hub token issue` / `grant add` / `token revoke` / `usage` |
101
+ | `producer` (`asp_...`) | the agent on the producer's machine | set as `token` in `~/.aweshare/config.toml`; the agent registers its offerings with it |
102
+ | `consumer` (`asc_...`) | whoever calls the models | set in SDK env vars (`ANTHROPIC_AUTH_TOKEN` / `OPENAI_API_KEY`); the hub uses it to decide which aliases they may call |
103
+
96
104
  The producer's `name` becomes their alias namespace (the `peng/` in `peng/gpt-4o`).
97
105
 
98
106
  ### 2. Producer first run (in this order)
@@ -238,6 +246,13 @@ Health: agent heartbeats every 15s, silent 45s = dead; backends with 2 consecuti
238
246
 
239
247
  Updating a npm install: `aweshare self-update` (asks before installing; `--check` only shows versions). The CLI also reminds you at most once a day when a newer npm release exists.
240
248
 
249
+ ## Known limitations (v1)
250
+
251
+ - No cross-protocol conversion: an alias speaks exactly one wire (openai chat, anthropic messages, or openai responses).
252
+ - Ollama streams carry no usage → token counts recorded as NULL (best effort by design).
253
+ - Single hub instance + SQLite; no horizontal scaling.
254
+ - Corporate proxies may block the WebSocket tunnel (environmental limit).
255
+
241
256
  ## Development
242
257
 
243
258
  ```bash
@@ -259,11 +274,19 @@ Releasing: push a `v*` tag with a matching `## [x.y.z]` section in `docs/CHANGEL
259
274
 
260
275
  Layout: `packages/protocol` (shared wire protocol) · `apps/hub` (HTTP+WS+SQLite+CLI) · `apps/agent` (CLI). Design docs live in `docs/specs/`; the changelog in `docs/CHANGELOG.md`; contribution scope in [CONTRIBUTING.md](./CONTRIBUTING.md).
261
276
 
262
- ## Known limitations (v1)
277
+ ## Support
263
278
 
264
- - No cross-protocol conversion: an alias speaks exactly one wire (openai chat, anthropic messages, or openai responses).
265
- - Ollama streams carry no usage → token counts recorded as NULL (best effort by design).
266
- - Single hub instance + SQLite; no horizontal scaling.
267
- - Corporate proxies may block the WebSocket tunnel (environmental limit).
279
+ If aweshare saves you a subscription or a GPU box, consider supporting it:
280
+
281
+ - Star the repo it helps others find it.
282
+ - [Ko-fi](https://ko-fi.com/mugpeng) buy me a coffee.
283
+ - 💬 WeChat — scan the QR code below.
284
+
285
+ <p align="center">
286
+ <img src="assets/images/wechat-pay.jpg" alt="WeChat Pay" width="240">
287
+ </p>
288
+
289
+ > aweshare is free to use and self-host. Sponsors keep it maintained — thank you.
268
290
 
269
- MIT License.
291
+ Licensed under the aweshare Proprietary License — free to use and self-host,
292
+ no redistribution. See [LICENSE](./LICENSE).
package/package.json CHANGED
@@ -1,9 +1,9 @@
1
1
  {
2
2
  "name": "aweshare",
3
- "version": "0.2.6",
3
+ "version": "0.2.8",
4
4
  "type": "module",
5
5
  "description": "Open-source, local-first AI capability relay",
6
- "license": "MIT",
6
+ "license": "UNLICENSED",
7
7
  "repository": {
8
8
  "type": "git",
9
9
  "url": "git+https://github.com/wehuman01/aweshare.git"