@fungi.computer/oyster 0.34.0 → 0.35.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 +62 -1
- package/dist/boot-host-script.js +1 -1
- package/dist/embed-metafiles.js +2 -2
- package/dist/hello-app-script.js +1 -1
- package/dist/host.d.ts +2 -0
- package/dist/host.js +3 -2
- package/dist/page/mount.js +1 -0
- package/dist/page-config.d.ts +1 -0
- package/dist/page-config.js +1 -0
- package/dist/page-script.js +1 -1
- package/dist/standalone/registry.d.ts +2 -0
- package/dist/standalone/registry.js +7 -0
- package/dist/standalone/worker.d.ts +1 -1
- package/dist/standalone/worker.js +17 -4
- package/dist/workers.d.ts +1 -0
- package/dist/workers.js +5 -1
- package/docs/api/host.md +1 -0
- package/docs/api/page/mount.md +21 -19
- package/docs/api/workers.md +18 -16
- package/package.json +10 -10
package/README.md
CHANGED
|
@@ -1,5 +1,66 @@
|
|
|
1
1
|
# Oyster by Fungi (`@fungi.computer/oyster`)
|
|
2
2
|
|
|
3
|
+
Oyster gives you a desktop of apps that you and your AI agents can use on your
|
|
4
|
+
own computer or Cloudflare account.
|
|
5
|
+
|
|
6
|
+

|
|
7
|
+
|
|
8
|
+
## Quick start
|
|
9
|
+
|
|
10
|
+
With Node 24 or newer and Git installed, run:
|
|
11
|
+
|
|
12
|
+
```sh
|
|
13
|
+
npx @fungi.computer/oyster try
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Open the sign-in link it gives you. The desktop starts at
|
|
17
|
+
`http://127.0.0.1:8787` with a Hello App, then builds the other starter Apps in
|
|
18
|
+
the background. Press Ctrl-C to stop. Run the same command inside `my-oyster` to
|
|
19
|
+
restart.
|
|
20
|
+
|
|
21
|
+
## Common tasks
|
|
22
|
+
|
|
23
|
+
### Keep a trial running on another port
|
|
24
|
+
|
|
25
|
+
Use `npx @fungi.computer/oyster try --port 8788`. Add `--no-open` if you want to
|
|
26
|
+
open the browser yourself. [Local trial details](#local-trial-details) explain
|
|
27
|
+
where your files and logs live.
|
|
28
|
+
|
|
29
|
+
### Put it on your Cloudflare account
|
|
30
|
+
|
|
31
|
+
Follow [Deploy to Cloudflare](#deploy-to-cloudflare). The trial already contains
|
|
32
|
+
the Worker and its binding configuration.
|
|
33
|
+
|
|
34
|
+
### Connect a coding agent
|
|
35
|
+
|
|
36
|
+
[Create a named key and add the MCP endpoint](#connect-your-agents). Each
|
|
37
|
+
installed App becomes something the agent can call.
|
|
38
|
+
|
|
39
|
+
### Recover a broken App
|
|
40
|
+
|
|
41
|
+
Open `/recovery` and sign in as the owner. [Recovery](#recover-an-app) works
|
|
42
|
+
without loading the App or desktop, and explains when rollback is available.
|
|
43
|
+
|
|
44
|
+
### Build a smaller host
|
|
45
|
+
|
|
46
|
+
Start with [`createOysterWorker`](#build-your-own-host) if you want the App host
|
|
47
|
+
without the full desktop, Computer and git setup.
|
|
48
|
+
|
|
49
|
+
<details>
|
|
50
|
+
<summary>See the desktop at phone width</summary>
|
|
51
|
+
|
|
52
|
+

|
|
53
|
+
|
|
54
|
+
</details>
|
|
55
|
+
|
|
56
|
+
<!-- Capture: 2026-11-17, source 18c3145d6874aaf873cecb863c150da1b6e64ca0.
|
|
57
|
+
Ladle desktop--hero, light theme, 1280x720 and 390x844. Local fixture data,
|
|
58
|
+
real Tourtois UI. Captured with Playwright following scripts/capture-listing-art.mjs. -->
|
|
59
|
+
|
|
60
|
+
## Reference
|
|
61
|
+
|
|
62
|
+
### Overview
|
|
63
|
+
|
|
3
64
|
Fungi is an open-source workspace for AI agents: Apps that people and agents
|
|
4
65
|
both use, Computers that keep their files, and permissions the system checks.
|
|
5
66
|
Try it with one command, run it on your own Cloudflare account, or let us host
|
|
@@ -24,7 +85,7 @@ There are three ways in, from least to most code:
|
|
|
24
85
|
3. **Build your own host** with `createOysterWorker` when you want only part of
|
|
25
86
|
it.
|
|
26
87
|
|
|
27
|
-
##
|
|
88
|
+
## Local trial details
|
|
28
89
|
|
|
29
90
|
No Cloudflare account, Docker or payment. You need Node 24 or newer and Git.
|
|
30
91
|
|