@bibobonking/opensol 3.0.2 → 3.0.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 +15 -12
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,21 +4,24 @@ A local-first AI coding agent by OpenSoft. OpenSol pairs a warm React chat inter
|
|
|
4
4
|
|
|
5
5
|
The daemon binds to `127.0.0.1` only. It serves the prebuilt app from `dist/` and stores everything under `~/.maxcode`. API keys and hosting tokens are encrypted with AES-256-GCM using a local `master.key`; the browser only ever receives a masked hint.
|
|
6
6
|
|
|
7
|
-
## Run the built app
|
|
7
|
+
## Run the built app or install with npm
|
|
8
8
|
|
|
9
|
-
Requires Node.js 20 or newer. No `
|
|
9
|
+
Requires Node.js 20 or newer. No `node_modules` is needed to run the built app.
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
npm start
|
|
13
|
-
```
|
|
11
|
+
## Install globally via npm
|
|
14
12
|
|
|
15
|
-
|
|
13
|
+
```bash
|
|
14
|
+
npm install -g @bibobonking/opensol
|
|
16
15
|
|
|
17
16
|
```bash
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
17
|
+
npm start run
|
|
18
|
+
```
|
|
19
|
+
```
|
|
20
|
+
opensol start [--port=4174] [--open] [--foreground]
|
|
21
|
+
opensol stop
|
|
22
|
+
opensol status
|
|
23
|
+
opensol open
|
|
24
|
+
opensol logs
|
|
22
25
|
```
|
|
23
26
|
|
|
24
27
|
On first launch, choose a real project folder, then add a provider key in **Settings → Models** and pick a live model. Everything else — workspace tree, editor, git, search, build/plan modes, subagents and deploys — runs through the local daemon.
|
|
@@ -33,7 +36,7 @@ On first launch, choose a real project folder, then add a provider key in **Sett
|
|
|
33
36
|
- **Local plugins.** Two plugin modes:
|
|
34
37
|
- **API v1 (sandboxed):** Install a package, review its declared workspace capabilities and HTTPS domains, preview in a sandbox, mark it Safe. Plugin code gets a restricted API (`registerCommand`, `registerPanel`, `registerTheme`, workspace read/write, HTTPS-only network to declared hosts).
|
|
35
38
|
- **API v2 (free):** Plugin receives the full Cordis kernel context — register custom AI tools, hook into `agent/request` / `tools/execute` / `system-prompt/assemble` events, patch any app behaviour at runtime. No capability declarations needed. When removed, the Cordis fiber disposes automatically and the app returns to its original state — no source files are ever modified.
|
|
36
|
-
The same panel builds a package from a folder you pick. Packages live under `~/.
|
|
39
|
+
The same panel builds a package from a folder you pick. Packages live under `~/.opensol/plugins`, outside the selected workspace.
|
|
37
40
|
- **Workspace panel.** Folder tree, file editor, git status and quick file actions.
|
|
38
41
|
- **Deploy.** Cloudflare Pages, Netlify and Vercel, for the open workspace or another existing folder. Tokens stay in the daemon and are passed to CLIs through environment variables.
|
|
39
42
|
- **Local history.** Conversations, settings, workspaces and encrypted keys survive restarts.
|
|
@@ -57,7 +60,7 @@ OpenCode free-tier models only work inside OpenCode itself, so they are hidden h
|
|
|
57
60
|
|
|
58
61
|
## Data and security
|
|
59
62
|
|
|
60
|
-
- Data directory: `~/.
|
|
63
|
+
- Data directory: `~/.opensol` (override with `OPENSOL_DATA`).
|
|
61
64
|
- `secrets.enc` and `master.key` are created with mode `600`.
|
|
62
65
|
- All API routes require the local session cookie and a CSRF header; Host and Origin are checked.
|
|
63
66
|
- The daemon rejects code execution outside the selected workspace except for an explicit, existing deploy folder.
|