@ecmaos/kernel 0.2.7 → 0.3.0

package/README.md

@@ -141,6 +141,7 @@ The goal is to create a kernel and supporting apps that tie together modern web
   - Terminal (xterm.js)
   - User Manager
   - WASM Loader
+  - [WebContainer](https://github.com/stackblitz/webcontainer-core) for running Node.js apps
   - Window Manager (WinBox)
   - Workers (Web Workers)
 
@@ -169,6 +170,8 @@ The goal is to create a kernel and supporting apps that tie together modern web
 
 - Packages are [NPM packages](https://www.npmjs.com) that are installed into the ecmaOS environment
 - They can be installed from the terminal using the `install` command, e.g. `# install jquery`
+- Client-side packages should work well
+- Some basic Node emulation is in place, but don't expect anything to work at this point
 - NPM version specifiers are supported, e.g.:
   - `# install jquery@3.7.1`
   - `# install jquery@^3.7.1`
@@ -199,7 +202,7 @@ The goal is to create a kernel and supporting apps that tie together modern web
 - `/dev/`: All devices are here
 - `/etc/packages`: A list of installed packages to load on boot
 - `/home/`: Contains user home directories
-- `/proc/`: A directory containing various dynamic system information
+- `/proc/`: Contains various dynamic system information
 - `/root/`: The home directory for the root user
 - `/usr/bin/`: Executable packages get linked here
 - `/usr/lib/`: All installed packages are here
@@ -278,30 +281,57 @@ echo "window.alert('Hello, world!')" > /root/hello.js
 load /root/hello.js
 ```
 
+## Scripting
+
+```txt
+#!ecmaos:bin:script
+echo "Hello, world!"
+install jquery
+```
+
+## Startup
+
+- `/boot/init` is a script that runs on boot inside the init process (PID 0)
+- `/etc/packages` is a list of already installed packages to load on boot; one per line
+- The env var `VITE_KERNEL_MODULES` is a list of modules to load on boot; CSV with pinned versions
+- The env var `VITE_RECOMMENDED_APPS` is a list of apps to suggest to new users
+
 ## App Development
 
-The `apps` directory in the repository contains a number of examples of how to develop apps, but there are many approaches you could take.
+The [apps](/apps) directory in the repository contains some examples of how to develop apps, but there are many approaches you could take.
 
-- `@ecmaos-apps/boilerplate`: A minimal boilerplate app for developing new apps
+- `@ecmaos-apps/boilerplate`: A minimal boilerplate app for reference
 - `@ecmaos-apps/code`: A simple code editor app using [Monaco](https://microsoft.github.io/monaco-editor/); serves as a good reference for more complex apps
 
 Basically, your app's [bin](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#bin) file has a `main` (or default) function export that is passed the kernel reference and can use it to interact with the system as needed. A shebang line of `#!ecmaos:bin:app:myappname` is required at the top of the bin file to identify it as an app.
 
-## Kernel Interface Example
+## App/Kernel Interface Example
+
+> See the [docs](https://docs.ecmaos.sh) for more information
 
 ```ts
-export default async function main({ kernel }: ProcessEntryParams) {
-  kernel.log.info("Hello, world!");
-  kernel.terminal.writeln("Hello, world!");
+#!ecmaos:bin:app:example
+// shebang format: ecmaos:exectype:execnamespace:execname
+export default async function main(params: ProcessEntryParams) {
+  const { args, kernel, terminal } = params
+  kernel.log.info('Hello, world!')
+  kernel.log.debug(args)
+  terminal.writeln('Hello, world!')
+  await kernel.filesystem.fs.writeFile('/tmp/hello.txt', 'Hello, world!')
+  const win = kernel.windows.create({ title: 'Example', width: 800, height: 600 })
+  const container = document.createElement('div')
+  container.innerHTML = '<h1>Hello, world!</h1>'
+  win.mount(container)
 }
 ```
 
 ## Early Days
 
-The kernel is currently in active development. It is not considered stable and the structure and API are very likely to change in unexpected and possibly unannounced ways until version 1.0.0. Use cautiously and at your own risk.
+ecmaOS is currently in active development. It is not considered stable and the structure and API are very likely to change in unexpected and possibly unannounced ways until version 1.0.0. Use cautiously and at your own risk.
 
 Things to keep in mind:
 
+- If things go wrong or break, clear your browser cache and site data for ecmaOS
 - Things have changed a lot since the tests were written, so they need to be updated and fixed
 - The kernel is designed to be run in an environment with a DOM (i.e. a browser)
 - Many features are only available on Chromium-based browsers, and many more behind feature flags
@@ -313,6 +343,14 @@ Things to keep in mind:
 
 [Turborepo](https://turbo.build/repo) is used to manage the monorepo, and [pnpm](https://pnpm.io) is used for package management.
 
+PNPM Workspaces:
+
+- [apps](/apps)
+- [core](/core)
+- [devices](/devices)
+- [modules](/modules)
+- [utils](/utils)
+
 A good place to start is viewing the `scripts` property of [package.json](./package.json) in the root of the repository.
 
 ```bash
@@ -348,4 +386,6 @@ Also see [turbo.json](./turbo.json) and [CONTRIBUTING.md](/CONTRIBUTING.md) for
 
 ## Security Vulnerabilities
 
+See [SECURITY.md](/SECURITY.md) for more information.
+
 If you find a serious security vulnerability, please submit a new [Draft Security Advisory](https://github.com/ecmaos/ecmaos/security) or contact the project maintainer directly at [code@mathis.network](mailto:code@mathis.network).

package/dist/.vite/manifest.json

@@ -1,32 +1,32 @@
 {
-  "_browser-D_CtuxSB.js": {
-    "file": "browser-D_CtuxSB.js",
-    "name": "browser",
-    "isDynamicEntry": true,
-    "imports": [
-      "_empty--zdtkf0T.js"
-    ]
-  },
-  "_empty--zdtkf0T.js": {
-    "file": "empty--zdtkf0T.js",
-    "name": "empty",
+  "___vite-browser-external-ZgWJ_FY-.js": {
+    "file": "__vite-browser-external-ZgWJ_FY-.js",
+    "name": "__vite-browser-external",
     "dynamicImports": [
-      "_topbar.min-CDkSVOxV.js",
-      "_browser-D_CtuxSB.js",
+      "_topbar.min-DHDDU9sh.js",
+      "_browser-Bnkgx7wL.js",
       "src/tree/lib/commands/install.ts",
       "node_modules/.pnpm/figlet@1.8.0/node_modules/figlet/importable-fonts/Poison.js"
     ]
   },
+  "_browser-Bnkgx7wL.js": {
+    "file": "browser-Bnkgx7wL.js",
+    "name": "browser",
+    "isDynamicEntry": true,
+    "imports": [
+      "___vite-browser-external-ZgWJ_FY-.js"
+    ]
+  },
   "_kernel.css": {
     "file": "kernel.css",
     "src": "_kernel.css"
   },
-  "_topbar.min-CDkSVOxV.js": {
-    "file": "topbar.min-CDkSVOxV.js",
+  "_topbar.min-DHDDU9sh.js": {
+    "file": "topbar.min-DHDDU9sh.js",
     "name": "topbar.min",
     "isDynamicEntry": true,
     "imports": [
-      "_empty--zdtkf0T.js"
+      "___vite-browser-external-ZgWJ_FY-.js"
     ]
   },
   "node_modules/.pnpm/figlet@1.8.0/node_modules/figlet/importable-fonts/Poison.js": {
@@ -41,16 +41,16 @@
     "src": "src/tree/kernel.ts",
     "isEntry": true,
     "imports": [
-      "_empty--zdtkf0T.js"
+      "___vite-browser-external-ZgWJ_FY-.js"
     ]
   },
   "src/tree/lib/commands/install.ts": {
-    "file": "install-Ds1oWgTf.js",
+    "file": "install-BWxc1crE.js",
     "name": "install",
     "src": "src/tree/lib/commands/install.ts",
     "isDynamicEntry": true,
     "imports": [
-      "_empty--zdtkf0T.js"
+      "___vite-browser-external-ZgWJ_FY-.js"
     ]
   },
   "src/ui.ts": {
@@ -59,7 +59,7 @@
     "src": "src/ui.ts",
     "isEntry": true,
     "imports": [
-      "_empty--zdtkf0T.js"
+      "___vite-browser-external-ZgWJ_FY-.js"
     ]
   }
 }