aweshare 0.2.1 → 0.2.3
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 +32 -12
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,13 +1,33 @@
|
|
|
1
1
|
<div align="center">
|
|
2
|
-
|
|
3
|
-
<
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
2
|
+
<img src="./logo/logo.png" alt="aweshare" width="760">
|
|
3
|
+
<h1>aweshare: Local-first AI Capability Relay</h1>
|
|
4
|
+
<p><strong>An open-source, local-first AI capability relay.</strong></p>
|
|
5
|
+
<p>Share local Ollama/vLLM or authorized OpenAI/Anthropic backends through a grant-based hub, consumed with standard SDKs via <code>namespace/alias</code>.</p>
|
|
6
|
+
<p><strong>Upstream API keys never leave the producer's device.</strong></p>
|
|
7
|
+
<p>
|
|
8
|
+
<strong>English</strong> ·
|
|
9
|
+
<a href="./README_cn.md">简体中文</a> ·
|
|
10
|
+
<a href="https://www.npmjs.com/package/aweshare">npm</a> ·
|
|
11
|
+
<a href="https://github.com/wehuman01/aweshare">GitHub</a>
|
|
12
|
+
</p>
|
|
13
|
+
<p>
|
|
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
|
+
</p>
|
|
16
|
+
<p>
|
|
17
|
+
<a href="https://github.com/wehuman01/aweshare-source/releases"><img src="https://img.shields.io/badge/version-0.2.3-7C3AED?style=flat-square" alt="Version"></a>
|
|
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>
|
|
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
|
+
</p>
|
|
22
|
+
<p>
|
|
23
|
+
<img src="https://img.shields.io/badge/status-beta-c96a3d?style=flat-square" alt="Status">
|
|
24
|
+
<img src="https://img.shields.io/badge/docker-ghcr.io%2Fwehuman01%2Faweshare-2496ED?style=flat-square&logo=docker" alt="Docker image">
|
|
25
|
+
<img src="https://img.shields.io/badge/protocol-OpenAI%20%7C%20Anthropic-0ea5a4?style=flat-square" alt="Protocols">
|
|
26
|
+
<img src="https://img.shields.io/badge/platform-docker%20%7C%20npm%20%7C%20node-334155?style=flat-square" alt="Platform">
|
|
27
|
+
<img src="https://img.shields.io/npm/dt/aweshare?style=flat-square" alt="npm downloads">
|
|
28
|
+
<img src="https://img.shields.io/github/stars/wehuman01/aweshare?style=flat-square" alt="GitHub stars">
|
|
29
|
+
<img src="https://img.shields.io/badge/deploy-self%20hosted-334155?style=flat-square" alt="Self hosted">
|
|
30
|
+
</p>
|
|
11
31
|
</div>
|
|
12
32
|
|
|
13
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.
|
|
@@ -46,7 +66,7 @@ Consumer (standard SDK, zero changes) Producer side
|
|
|
46
66
|
|
|
47
67
|
## Quickstart
|
|
48
68
|
|
|
49
|
-
Published as [`aweshare`](https://www.npmjs.com/package/aweshare) on npm (requires Node ≥ 22) and as a Docker image (`ghcr.io/
|
|
69
|
+
Published as [`aweshare`](https://www.npmjs.com/package/aweshare) on npm (requires Node ≥ 22) and as a Docker image (`ghcr.io/wehuman01/aweshare`). No clone needed.
|
|
50
70
|
|
|
51
71
|
### 1. Start the hub (operator, one VPS)
|
|
52
72
|
|
|
@@ -62,7 +82,7 @@ aweshare hub serve # listens on :8787 (put Caddy/nginx TLS in front)
|
|
|
62
82
|
|
|
63
83
|
```bash
|
|
64
84
|
docker run -d --name aweshare-hub --restart unless-stopped \
|
|
65
|
-
-p 127.0.0.1:8787:8787 -v "$PWD/data:/data" ghcr.io/
|
|
85
|
+
-p 127.0.0.1:8787:8787 -v "$PWD/data:/data" ghcr.io/wehuman01/aweshare:latest
|
|
66
86
|
docker exec aweshare-hub node apps/hub/dist/cli.js init # first run: prints the admin token, save it
|
|
67
87
|
```
|
|
68
88
|
|
|
@@ -232,7 +252,7 @@ aweshare hub serve
|
|
|
232
252
|
aweshare agent doctor
|
|
233
253
|
```
|
|
234
254
|
|
|
235
|
-
Releasing: push a `v*` tag with a matching `## [x.y.z]` section in `docs/CHANGELOG.md`; CI publishes `aweshare
|
|
255
|
+
Releasing: push a `v*` tag with a matching `## [x.y.z]` section in `docs/CHANGELOG.md`; CI publishes the `aweshare` package to npm via Trusted Publishing (OIDC, no token secret), pushes the Docker image to `ghcr.io/wehuman01/aweshare`, and mirrors user-facing docs to the public repo (`wehuman01/aweshare`).
|
|
236
256
|
|
|
237
257
|
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).
|
|
238
258
|
|
package/package.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "aweshare",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.3",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Open-source, local-first AI capability relay",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"repository": {
|
|
8
8
|
"type": "git",
|
|
9
|
-
"url": "git+https://github.com/
|
|
9
|
+
"url": "git+https://github.com/wehuman01/aweshare.git"
|
|
10
10
|
},
|
|
11
11
|
"bin": {
|
|
12
12
|
"aweshare": "./bin/aweshare.mjs"
|