npm - @ecmaos/kernel - Versions diffs - 0.9.2 → 0.9.4 - Mend

@ecmaos/kernel 0.9.2 → 0.9.4

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 (468) hide show

package/dist/initfs.demo/usr/share/docs/@ecmaos/kernel/docs/functions/kernel_src_tree_lib_screensavers_matrix.exit.html ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><style>body { visibility: hidden; }</style><meta charset="utf-8"><meta http-equiv="x-ua-compatible" content="IE=edge"><title>exit \| ecmaOS</title><meta name="description" content="Documentation for ecmaOS"><meta name="viewport" content="width=device-width, initial-scale=1"><link rel="stylesheet" href="../assets/style.css"><link rel="stylesheet" href="../assets/highlight.css"><link rel="stylesheet" href="../assets/custom.css"><script defer="" src="../assets/main.js"></script><script async="" src="../assets/icons.js" id="tsd-icons-script"></script><link rel="stylesheet" href="../assets/dmt/dmt-components.css"><link rel="stylesheet" href="../assets/dmt/dmt-theme.css"><script src="../assets/dmt/dmt-components.js" type="module"></script><link rel="icon" href="../favicon.ico"><noscript><style>body { visibility: visible; }</style></noscript></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") \|\| "os";</script><div class="overlay"></div>
2	+ <main><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field" id="dmt-search-main"></div><div class="field" id="dmt-toolbar"><a href="../index.html" class="title">ecmaOS</a></div></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main" tabindex="-1"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules/kernel_src_tree_lib_screensavers_matrix.html">kernel/src/tree/lib/screensavers/matrix</a></li><li><a href="kernel_src_tree_lib_screensavers_matrix.exit.html">exit</a></li></ul><div class="dmt-title-header-flex"><h1>Function exit</h1></div></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="exit" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exit</span><span class="tsd-signature-symbol">(</span><br>    <span class="tsd-kind-parameter">interval</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Timeout</span><span class="tsd-signature-symbol">,</span><br>    <span class="tsd-kind-parameter">canvas</span><span class="tsd-signature-symbol">:</span> <a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2024/dom/interfaces/HTMLCanvasElement-1.html" class="tsd-signature-type external" target="_blank">HTMLCanvasElement</a><span class="tsd-signature-symbol">,</span><br>    <span class="tsd-kind-parameter">terminal</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Terminal</span><span class="tsd-signature-symbol">,</span><br><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2024/es/interfaces/Promise-1.html" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#exit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">interval</span>: <span class="tsd-signature-type">Timeout</span></span></li><li><span><span class="tsd-kind-parameter">canvas</span>: <a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2024/dom/interfaces/HTMLCanvasElement-1.html" class="tsd-signature-type external" target="_blank">HTMLCanvasElement</a></span></li><li><span><span class="tsd-kind-parameter">terminal</span>: <span class="tsd-signature-type">Terminal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2024/es/interfaces/Promise-1.html" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ecmaos/ecmaos/blob/1c0b126756d00361abe4364eb322939a8d79c2fe/core/kernel/src/tree/lib/screensavers/matrix.ts#L48">core/kernel/src/tree/lib/screensavers/matrix.ts:48</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked=""><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">ecmaOS</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a> with the <a href="https://www.npmjs.com/package/@typhonjs-typedoc/typedoc-theme-dmt" target="_blank">Default Modern Theme</a></p></footer></main></body></html>

package/dist/initfs.demo/usr/share/docs/@ecmaos/kernel/docs/index.html ADDED Viewed

@@ -0,0 +1,347 @@
+<!DOCTYPE html><html class="default" lang="en" data-base="."><head><style>body { visibility: hidden; }</style><meta charset="utf-8"><meta http-equiv="x-ua-compatible" content="IE=edge"><title>ecmaOS</title><meta name="description" content="Documentation for ecmaOS"><meta name="viewport" content="width=device-width, initial-scale=1"><link rel="stylesheet" href="assets/style.css"><link rel="stylesheet" href="assets/highlight.css"><link rel="stylesheet" href="assets/custom.css"><script defer="" src="assets/main.js"></script><script async="" src="assets/icons.js" id="tsd-icons-script"></script><link rel="stylesheet" href="assets/dmt/dmt-components.css"><link rel="stylesheet" href="assets/dmt/dmt-theme.css"><script src="assets/dmt/dmt-components.js" type="module"></script><link rel="icon" href="favicon.ico"><noscript><style>body { visibility: visible; }</style></noscript></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";</script><div class="overlay"></div>
+<main><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field" id="dmt-search-main"></div><div class="field" id="dmt-toolbar"><a href="index.html" class="title">ecmaOS</a></div></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main" tabindex="-1"><div class="col-content"><div class="tsd-page-title"><div class="dmt-title-header-flex"><h1>ecmaOS</h1></div></div><div class="tsd-panel tsd-typography"><a id="the-web-kernel" class="tsd-anchor"></a><h1 class="tsd-anchor-link">The Web Kernel<a href="#the-web-kernel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p><a href="https://ecmaos.sh" target="_blank" class="external"><img src="https://img.shields.io/badge/launch-ecmaos.sh-blue?style=for-the-badge" alt="Launch ecmaOS.sh"></a></p>
+<blockquote>
+<p>Made with ❤️ by <a href="https://jaymath.is" target="_blank" class="external">Jay Mathis</a></p>
+<p><a href="https://github.com/mathiscode" target="_blank" class="external"><img src="https://img.shields.io/github/stars/mathiscode?style=flat&amp;logo=github&amp;label=%E2%AD%90%EF%B8%8F" alt="Stars"></a> <a href="https://github.com/mathiscode" target="_blank" class="external"><img src="https://img.shields.io/github/followers/mathiscode?style=flat&amp;logo=github&amp;label=follow" alt="Followers"></a></p>
+</blockquote>
+<p><a href="https://ecmaos.sh" target="_blank" class="external">ecmaOS</a> is a browser-based operating system kernel and suite of applications written primarily in TypeScript, AssemblyScript, and C++. It's the successor of <a href="https://github.com/web3os-org/kernel" target="_blank" class="external">web3os</a>.</p>
+<p>The goal is to create a kernel and supporting apps that tie together modern web technologies and utilities to form an "operating system" that can run on modern browsers, not just to create a "desktop experience". It offers the ability to run a wide variety of apps on top of an already (mostly) sandboxed foundation, offering some measure of security by default as well as rich developer tooling. Its main use case is to provide a consistent environment for running web apps, but it has features that allow for more powerful custom scenarios, such as a platform for custom applications, games, and more.</p>
+<p>This is NOT intended to be a "Linux kernel in Javascript" - while it takes its heaviest inspiration from Linux, it is more experimental and follows different design principles and architecture, and also doesn't need to cover nearly the same scope.</p>
+<hr>
+<blockquote>
+<p><em>"The computer can be used as a tool to liberate and protect people, rather than to control them."</em>
+— Hal Finney</p>
+</blockquote>
+<p><a href="https://www.npmjs.com/package/@ecmaos/kernel" target="_blank" class="external"><img src="https://img.shields.io/github/package-json/v/ecmaos/ecmaos?color=success" alt="Version"></a>
+<a href="https://ecmaos.sh" target="_blank" class="external"><img src="https://img.shields.io/website?url=https%3A%2F%2Fecmaos.sh" alt="Site Status"></a>
+<a href="https://github.com/ecmaos/ecmaos/pulse" target="_blank" class="external"><img src="https://img.shields.io/github/created-at/ecmaos/ecmaos?style=flat&amp;label=created&amp;color=success" alt="Created"></a>
+<a href="https://github.com/ecmaos/ecmaos/commit/main" target="_blank" class="external"><img src="https://img.shields.io/github/last-commit/ecmaos/ecmaos.svg" alt="Last Commit"></a>
+<a href="https://docs.ecmaos.sh" target="_blank" class="external"><img src="https://img.shields.io/badge/API-Reference-success" alt="API Reference"></a>
+<a href="https://github.com/ecmaos/ecmaos/blob/main/LICENSE" target="_blank" class="external"><img src="https://img.shields.io/badge/license-MIT+Apache2.0-success" alt="GitHub license"></a></p>
+<p><a href="https://github.com/ecmaos/ecmaos/issues" target="_blank" class="external"><img src="https://img.shields.io/github/issues/ecmaos/ecmaos.svg?logo=github" alt="Open issues"></a>
+<a href="https://github.com/ecmaos/ecmaos/issues?q=is%3Aissue+is%3Aclosed" target="_blank" class="external"><img src="https://img.shields.io/github/issues-closed/ecmaos/ecmaos.svg?logo=github" alt="Closed issues"></a>
+<a href="https://github.com/ecmaos/ecmaos/pulls" target="_blank" class="external"><img src="https://img.shields.io/github/issues-pr-raw/ecmaos/ecmaos.svg?logo=github&amp;label=PRs" alt="Open PRs"></a>
+<a href="https://github.com/ecmaos/ecmaos/pulls?q=is%3Apr+is%3Aclosed" target="_blank" class="external"><img src="https://img.shields.io/github/issues-pr-closed/ecmaos/ecmaos.svg?logo=github&amp;label=PRs" alt="Closed PRs"></a></p>
+<p><a href="https://github.com/ecmaos/ecmaos/stargazers" target="_blank" class="external"><img src="https://img.shields.io/github/stars/ecmaos/ecmaos?style=flat&amp;logo=github&amp;label=%E2%AD%90%EF%B8%8F%20stars" alt="Star on GitHub"></a>
+<a href="https://github.com/ecmaos/ecmaos/forks" target="_blank" class="external"><img src="https://img.shields.io/github/forks/ecmaos/ecmaos?style=flat&amp;logo=github&amp;label=%F0%9F%94%80%20forks" alt="GitHub forks"></a>
+<a href="https://github.com/ecmaos/ecmaos/watchers" target="_blank" class="external"><img src="https://img.shields.io/github/watchers/ecmaos/ecmaos?style=flat&amp;logo=github&amp;label=%F0%9F%91%80%20watchers" alt="GitHub watchers"></a>
+<a href="https://github.com/sponsors/mathiscode" target="_blank" class="external"><img src="https://img.shields.io/github/sponsors/mathiscode?color=red&amp;logo=github&amp;label=%F0%9F%92%96%20sponsors" alt="Sponsors"></a>
+<a href="https://github.com/ecmaos/ecmaos/graphs/contributors" target="_blank" class="external"><img src="https://img.shields.io/github/contributors/ecmaos/ecmaos?color=yellow&amp;logo=github&amp;label=%F0%9F%91%A5%20contributors" alt="Contributors"></a></p>
+<p><a href="https://discord.gg/ZJYGkbVsCh" target="_blank" class="external"><img src="https://img.shields.io/discord/1311804229127508081?label=discord&amp;logo=discord&amp;logoColor=white" alt="Discord"></a>
+<a href="https://matrix.to/#/#ecmaos:matrix.org" target="_blank" class="external"><img src="https://img.shields.io/matrix/ecmaos:matrix.org.svg?label=%23ecmaos%3Amatrix.org&amp;logo=matrix&amp;logoColor=white" alt="Matrix"></a>
+<a href="https://ecmaos.bsky.social" target="_blank" class="external"><img src="https://img.shields.io/badge/follow-on%20Bluesky-blue?logo=bluesky&amp;logoColor=white" alt="Bluesky"></a>
+<a href="https://www.reddit.com/r/ecmaos" target="_blank" class="external"><img src="https://img.shields.io/reddit/subreddit-subscribers/ecmaos?style=flat&amp;logo=reddit&amp;logoColor=white&amp;label=r/ecmaos" alt="Reddit"></a></p>
+<a id="features" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Features<a href="#features" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
+<li>TypeScript, WebAssembly, AssemblyScript, C++</li>
+<li>Filesystem supporting multiple backends powered by <a href="https://github.com/zen-fs/core" target="_blank" class="external">zenfs</a></li>
+<li>Terminal interface powered by <a href="https://xtermjs.org" target="_blank" class="external">xterm.js</a></li>
+<li>Pseudo-streams, allowing redirection and piping</li>
+<li>Device framework with a common interface for working with hardware: WebBluetooth, WebSerial, WebHID, WebUSB, etc.</li>
+<li>Some devices have a builtin CLI, so you can run them like normal commands: <code># /dev/bluetooth</code></li>
+<li>Install any client-side npm package (this doesn't mean it will work out of the box as expected)</li>
+<li>Event manager for dispatching and subscribing to events</li>
+<li>Process manager for running applications and daemons</li>
+<li>Interval manager for scheduling recurring operations with support for cron expressions via the <code>cron</code> command</li>
+<li>Memory manager for managing pseudo-memory: Collections, Config, Heap, and Stack</li>
+<li>Storage manager for managing Storage API capabilities: IndexedDB, localStorage, etc.</li>
+<li>Internationalization framework for translating text powered by <a href="https://www.i18next.com" target="_blank" class="external">i18next</a></li>
+<li>Window manager powered by <a href="https://github.com/nextapps-de/winbox" target="_blank" class="external">WinBox</a></li>
+</ul>
+<!-- - `BIOS`: A C++ module compiled to WebAssembly with [Emscripten](https://emscripten.org) providing performance-critical functionality -->
+<!-- - `Jaffa`: A [Tauri](https://tauri.app) app for running ecmaOS in a desktop or mobile environment -->
+<ul>
+<li><code>Metal</code>: An API server for allowing connections to physical systems from ecmaOS using <a href="https://hono.dev" target="_blank" class="external">Hono</a></li>
+<li><code>SWAPI</code>: An API server running completely inside a service worker using <a href="https://hono.dev" target="_blank" class="external">Hono</a></li>
+</ul>
+<a id="basic-concepts" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Basic Concepts<a href="#basic-concepts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><a id="apps" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Apps<a href="#apps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><blockquote>
+<p><a href="/apps">/apps</a></p>
+</blockquote>
+<ul>
+<li>These are full applications that are developed specifically to work with ecmaOS</li>
+<li>Refer to the full list of <a href="https://www.npmjs.com/org/ecmaos-apps" target="_blank" class="external">official published apps on npm</a></li>
+<li>See the <a href="/APPS.md">APPS.md</a> file for a list of community apps; submit a PR to add your app!</li>
+<li>An app is an npm package, in which the bin file has a shebang line of <code>#!ecmaos:bin:app:myappname</code></li>
+<li>Its default export (or exported <code>main</code> function) will be called with the <code>ProcessEntryParams</code> object</li>
+<li>They can be installed from the terminal using the <code>install</code> command, e.g. <code># install @ecmaos-apps/code</code></li>
+<li>Run the installed app (bins are linked to <code>/usr/bin</code>): <code># code /root/hello.js</code></li>
+<li>During development, it can be useful to run a <a href="https://github.com/verdaccio/verdaccio" target="_blank" class="external">Verdaccio</a> server to test local packages</li>
+<li>To publish to Verdaccio, run <code># npm publish --registry http://localhost:4873</code> in your app's development environment</li>
+<li>Then to install from your local registry, run (inside ecmaOS) <code># install @myscope/mypackage --registry http://localhost:4873</code></li>
+</ul>
+<!-- Will revamp once more work is done on this -->
+<!-- ### BIOS
+> [/core/bios](/core/bios)
+- The BIOS is a C++ module compiled to WebAssembly with [Emscripten](https://emscripten.org) providing performance-critical functionality
+- The BIOS has its own filesystem, located at `/bios` — this allows data to be copied in and out of the BIOS for custom code and utilities
+- The main idea is that data and custom code can be loaded into it from the OS for WASM-native performance, as well as providing various utilities
+- Confusingly, the Kernel loads the BIOS — not the other way around -->
+<a id="commands" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Commands<a href="#commands" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><blockquote>
+<p><a href="/core/kernel/src/tree/lib/commands">/core/kernel/src/tree/lib/commands</a></p>
+</blockquote>
+<ul>
+<li><code>Commands</code> are built-in shell commands that are provided by the kernel, e.g. <code>download</code>, <code>install</code>, <code>load</code>, etc.</li>
+</ul>
+<a id="coreutils" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Coreutils<a href="#coreutils" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><blockquote>
+<p><a href="/core/utils">/core/utils</a></p>
+</blockquote>
+<ul>
+<li><code>Coreutils</code> are similar to <code>Commands</code>, but are provided by the <code>@ecmaos/coreutils</code> package, e.g. <code>cat</code>, <code>cd</code>, <code>chmod</code>, <code>cp</code>, <code>echo</code>, <code>ls</code>, <code>mkdir</code>, <code>mv</code>, <code>pwd</code>, <code>rm</code>, <code>rmdir</code>, <code>stat</code>, <code>touch</code>, etc.</li>
+</ul>
+<a id="devices" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Devices<a href="#devices" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><blockquote>
+<p><a href="/devices">/devices</a></p>
+</blockquote>
+<ul>
+<li>Refer to the full list of <a href="https://www.npmjs.com/org/ecmaos-devices" target="_blank" class="external">official devices on npm</a></li>
+<li>See the <a href="/DEVICES.md">DEVICES.md</a> file for a list of community devices; submit a PR to add your device!</li>
+<li>Devices get loaded on boot, e.g. <code>/dev/bluetooth</code>, <code>/dev/random</code>, <code>/dev/battery</code>, etc.</li>
+<li>A device can support being "run" by a user, e.g. <code># /dev/battery status</code></li>
+<li>Devices may also be directly read/written using <code>fs</code> methods, and will behave accordingly (or have no effect if not supported)</li>
+<li>An individual device module can provide multiple device drivers, e.g. <code>/dev/usb</code> provides <code>/dev/usb-mydevice-0001-0002</code></li>
+</ul>
+<a id="filesystems" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Filesystems<a href="#filesystems" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><blockquote>
+<p><a href="/core/utils/src/commands/mount.ts">/core/utils/src/commands/mount.ts</a></p>
+</blockquote>
+<p>ecmaOS supports multiple filesystem backends powered by <a href="https://zenfs.dev" target="_blank" class="external">zenfs</a>, allowing you to mount various storage types into the virtual filesystem.</p>
+<a id="supported-filesystem-types" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Supported Filesystem Types<a href="#supported-filesystem-types" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
+<li><strong>memory</strong>: In-memory filesystem (temporary, lost on page reload)</li>
+<li><strong>indexeddb</strong>: IndexedDB-backed persistent filesystem</li>
+<li><strong>webstorage</strong>: WebStorage-backed filesystem (localStorage or sessionStorage)</li>
+<li><strong>webaccess</strong>: File System Access API filesystem (requires user interaction)</li>
+<li><strong>singlebuffer</strong>: Filesystem backed by a single buffer</li>
+<li><strong>fetch</strong>: Remote filesystem via HTTP fetch</li>
+<li><strong>xml</strong>: DOM XML filesystem (WIP)</li>
+<li><strong>zip</strong>: Read-only filesystem from a zip archive (file or URL)</li>
+<li><strong>iso</strong>: Read-only filesystem from an ISO image (file or URL)</li>
+<li><strong>dropbox</strong>: Dropbox filesystem (WIP)</li>
+<li><strong>s3</strong>: S3 filesystem (WIP)</li>
+<li><strong>googledrive</strong>: Google Drive filesystem (WIP)</li>
+</ul>
+<a id="basic-usage" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Basic Usage<a href="#basic-usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="sh"><span class="hl-0"># Mount a memory filesystem</span><br><span class="hl-1">mount</span><span class="hl-2"> </span><span class="hl-3">-t</span><span class="hl-2"> </span><span class="hl-4">memory</span><span class="hl-2"> </span><span class="hl-4">/mnt/tmp</span><br><br><span class="hl-0"># Mount an IndexedDB store</span><br><span class="hl-1">mount</span><span class="hl-2"> </span><span class="hl-3">-t</span><span class="hl-2"> </span><span class="hl-4">indexeddb</span><span class="hl-2"> </span><span class="hl-4">mydb</span><span class="hl-2"> </span><span class="hl-4">/mnt/db</span><br><br><span class="hl-0"># Mount WebStorage (localStorage by default)</span><br><span class="hl-1">mount</span><span class="hl-2"> </span><span class="hl-3">-t</span><span class="hl-2"> </span><span class="hl-4">webstorage</span><span class="hl-2"> </span><span class="hl-4">/mnt/storage</span><br><br><span class="hl-0"># Mount WebStorage using sessionStorage</span><br><span class="hl-1">mount</span><span class="hl-2"> </span><span class="hl-3">-t</span><span class="hl-2"> </span><span class="hl-4">webstorage</span><span class="hl-2"> </span><span class="hl-4">/mnt/storage</span><span class="hl-2"> </span><span class="hl-3">-o</span><span class="hl-2"> </span><span class="hl-4">storage=sessionStorage</span><br><br><span class="hl-0"># Mount a zip archive</span><br><span class="hl-1">mount</span><span class="hl-2"> </span><span class="hl-3">-t</span><span class="hl-2"> </span><span class="hl-4">zip</span><span class="hl-2"> </span><span class="hl-4">/tmp/archive.zip</span><span class="hl-2"> </span><span class="hl-4">/mnt/zip</span><br><br><span class="hl-0"># Mount from a remote URL</span><br><span class="hl-1">mount</span><span class="hl-2"> </span><span class="hl-3">-t</span><span class="hl-2"> </span><span class="hl-4">zip</span><span class="hl-2"> </span><span class="hl-4">https://example.com/archive.zip</span><span class="hl-2"> </span><span class="hl-4">/mnt/zip</span><br><br><span class="hl-0"># Mount a fetch filesystem (see utils/fetch-fs-server.js)</span><br><span class="hl-1">mount</span><span class="hl-2"> </span><span class="hl-3">-t</span><span class="hl-2"> </span><span class="hl-4">fetch</span><span class="hl-2"> </span><span class="hl-4">index.json</span><span class="hl-2"> </span><span class="hl-4">/mnt/api</span><span class="hl-2"> </span><span class="hl-3">-o</span><span class="hl-2"> </span><span class="hl-4">baseUrl=http://localhost:30808</span><br><br><span class="hl-0"># List all mounted filesystems</span><br><span class="hl-1">mount</span><span class="hl-2"> </span><span class="hl-3">-l</span><br><br><span class="hl-0"># Unmount a filesystem</span><br><span class="hl-1">umount</span><span class="hl-2"> </span><span class="hl-4">/mnt/tmp</span>
+</code><button type="button">Copy</button></pre>
+<a id="etcfstab" class="tsd-anchor"></a><h4 class="tsd-anchor-link">/etc/fstab<a href="#etcfstab" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The kernel automatically processes <code>/etc/fstab</code> during boot to mount filesystems. The fstab format is space or tab-separated:</p>
+<pre><code class="plaintext">source target type [options]
+</code><button type="button">Copy</button></pre>
+<p><strong>Format:</strong></p>
+<ul>
+<li><code>source</code>: Device/URL/database name (use <code>none</code> for filesystems that don't require a source)</li>
+<li><code>target</code>: Mount point (absolute path)</li>
+<li><code>type</code>: Filesystem type</li>
+<li><code>options</code>: Optional comma-separated key=value pairs</li>
+</ul>
+<p><strong>Example /etc/fstab:</strong></p>
+<pre><code class="plaintext"># ecmaOS fstab - Filesystem mount table
+# Format: source target type [options]
+# Memory filesystem for temporary data
+none /mnt/tmp memory
+# IndexedDB filesystem for persistent storage
+mydb /mnt/db indexeddb
+# WebStorage filesystem using localStorage
+none /mnt/storage webstorage storage=localStorage
+# Fetch filesystem from a remote API
+index.json /mnt/api fetch baseUrl=http://localhost:30808
+</code><button type="button">Copy</button></pre>
+<a id="generators" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Generators<a href="#generators" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><blockquote>
+<p><a href="/turbo/generators">/turbo/generators</a></p>
+</blockquote>
+<ul>
+<li>Generators are used to scaffold new apps, devices, modules, etc.</li>
+<li>They are located in the <code>turbo/generators</code> directory of the repository</li>
+<li>They are used by the <code>turbo gen</code> command, e.g. <code>turbo gen app</code>, <code>turbo gen device</code>, <code>turbo gen module</code>, etc.</li>
+</ul>
+<!-- Will revamp once more work is done on this -->
+<!-- ### Jaffa
+> [/core/jaffa](/core/jaffa)
+- Jaffa is a [Tauri](https://tauri.app) wrapper for the ecmaOS kernel
+- It's used to tie the kernel into a desktop or mobile environment, allowing for native functionality
+- It needs more work -->
+<a id="kernel" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Kernel<a href="#kernel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><blockquote>
+<p><a href="/core/kernel">/core/kernel</a></p>
+</blockquote>
+<ul>
+<li>The kernel ties together the various components of the system into a cohesive whole
+<ul>
+<li>Authentication (Passwords, Passkeys, Credentials)</li>
+<li>Components (Web Components/Custom Elements)</li>
+<li>Coreutils (Built-in commands)</li>
+<li>Devices (Web Hardware APIs)</li>
+<li>DOM (DOM Utilities and Interfaces)</li>
+<li>Events (CustomEvents)</li>
+<li>Filesystem (ZenFS)</li>
+<li>Internationalization (i18next)</li>
+<li>Interval Manager (setInterval and cron scheduling)</li>
+<li>Log Manager (tslog)</li>
+<li>Memory Manager (Abstractions)</li>
+<li>Process Manager</li>
+<li>Protocol Handlers (web+ecmaos://...)</li>
+<li>Service Worker Manager</li>
+<li>Shell</li>
+<li>Sockets (WebSocket, WebTransport)</li>
+<li>Storage (IndexedDB, localStorage, sessionStorage, etc.)</li>
+<li>Telemetry (OpenTelemetry)</li>
+<li>Terminal (xterm.js)</li>
+<li>User Manager</li>
+<li>WASM Loader</li>
+</ul>
+<!-- - [WebContainer](https://github.com/stackblitz/webcontainer-core) for running Node.js apps -->
+<ul>
+<li>Web Workers</li>
+<li>Window Manager (WinBox)</li>
+</ul>
+</li>
+</ul>
+<a id="metal" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Metal<a href="#metal" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><blockquote>
+<p><a href="/core/metal">/core/metal</a></p>
+</blockquote>
+<ul>
+<li>Metal is an API server for allowing connections to physical systems from ecmaOS using <a href="https://hono.dev" target="_blank" class="external">Hono</a></li>
+<li>Authenticated and encrypted connections with JWK/JWE/JOSE</li>
+</ul>
+<a id="modules" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Modules<a href="#modules" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><blockquote>
+<p><a href="/modules">/modules</a></p>
+</blockquote>
+<ul>
+<li>Refer to the full list of <a href="https://www.npmjs.com/org/ecmaos-modules" target="_blank" class="external">official modules on npm</a></li>
+<li>See the <a href="/MODULES.md">MODULES.md</a> file for a list of community modules; submit a PR to add your module!</li>
+<li>Modules are dynamically loaded into the kernel at boot and can be enabled or disabled</li>
+<li>They are specified during build via the <code>ECMAOS_KERNEL_MODULES</code> environment variable
+<ul>
+<li>e.g. <code>ECMAOS_KERNEL_MODULES=@ecmaos-modules/boilerplate@0.1.0,@your/package@1.2.3</code></li>
+</ul>
+</li>
+<li>Versions must be pinned and are mandatory - you cannot use NPM version specifiers</li>
+<li>They can provide additional functionality, devices, commands, etc.</li>
+<li>They offer a <a href="modules/types_modules.html">common interface</a> for interacting with the kernel</li>
+<li>Generally they should be written in <a href="https://www.assemblyscript.org" target="_blank" class="external">AssemblyScript</a>, but this isn't required</li>
+</ul>
+<a id="packages" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Packages<a href="#packages" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
+<li>Packages are <a href="https://www.npmjs.com" target="_blank" class="external">NPM packages</a> that are installed into the ecmaOS environment</li>
+<li>They can be installed from the terminal using the <code>install</code> command, e.g. <code># install @ecmaos-apps/ai</code></li>
+<li>Client-side packages should work well</li>
+<li>Some basic Node emulation is in place, but don't expect anything to work at this point</li>
+<li>NPM version specifiers are supported, e.g.:
+<ul>
+<li><code># install jquery@3.7.1</code></li>
+<li><code># install jquery@^3.7.1</code></li>
+<li><code># install jquery@latest</code></li>
+</ul>
+</li>
+<li><a href="https://jsr.io" target="_blank" class="external">JSR</a> may be used with the <a href="https://jsr.io/docs/npm-compatibility" target="_blank" class="external">NPM compatibility layer</a>:
+<ul>
+<li><code># install @jsr/defaude__hello-jsr --registry https://npm.jsr.io</code></li>
+</ul>
+</li>
+</ul>
+<a id="sockets" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Sockets<a href="#sockets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
+<li>A socket manager is available for creating and managing WebSocket and WebTransport connections</li>
+<li>It can be accessed via the <code>kernel.sockets</code> property or the <code>sockets</code> command</li>
+</ul>
+<a id="swapi" class="tsd-anchor"></a><h3 class="tsd-anchor-link">SWAPI<a href="#swapi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><blockquote>
+<p><a href="/core/swapi">/core/swapi</a></p>
+</blockquote>
+<ul>
+<li>The SWAPI is an API server running completely inside a service worker using <a href="https://hono.dev" target="_blank" class="external">Hono</a></li>
+<li>It allows for various operations including the <code>fs</code> route to fetch files via URL</li>
+<li>e.g., <code># fetch /swapi/fs/home/user/hello.txt</code></li>
+<li>e.g., <code># fetch /swapi/fake/person/fullName</code></li>
+</ul>
+<a id="telemetry" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Telemetry<a href="#telemetry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
+<li><a href="https://opentelemetry.io" target="_blank" class="external">OpenTelemetry</a> is used for collecting and analyzing telemetry data from the kernel and applications</li>
+<li>It is only active if the ECMAOS_OPENTELEMETRY_ENDPOINT environment variable is set when building the kernel</li>
+<li>There is a simple test server included in the <code>utils/opentelemetry</code> directory that can be used to test the telemetry system: <code>python3 utils/opentelemetry/otlp-server.py</code></li>
+</ul>
+<a id="utils" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Utils<a href="#utils" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><blockquote>
+<p><a href="/utils">/utils</a></p>
+</blockquote>
+<ul>
+<li>Utilities and configuration used during development</li>
+</ul>
+<a id="important-files-and-directories" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Important Files and Directories<a href="#important-files-and-directories" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
+<li><code>/bin/</code>: Built-in commands</li>
+</ul>
+<!-- - `/bios/`: The BIOS filesystem -->
+<ul>
+<li><code>/boot/init</code>: A script that runs on boot</li>
+<li><code>/dev/</code>: All devices are here</li>
+<li><code>/etc/crontab</code>: System-wide crontab file (loaded on boot)</li>
+<li><code>/etc/packages</code>: A list of installed packages to load on boot</li>
+<li><code>/home/</code>: Contains user home directories</li>
+<li><code>~/.config/crontab</code>: User-specific crontab file (loaded on login)</li>
+<li><code>/proc/</code>: Contains various dynamic system information</li>
+<li><code>/root/</code>: The home directory for the root user</li>
+<li><code>/usr/bin/</code>: Executable packages get linked here</li>
+<li><code>/usr/lib/</code>: All installed packages are here</li>
+<li><code>/var/log/kernel.log</code>: The kernel log</li>
+</ul>
+<a id="command-examples" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Command Examples<a href="#command-examples" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="sh"><span class="hl-1">ai</span><span class="hl-2"> </span><span class="hl-4">"Despite all my rage"</span><span class="hl-2"> </span><span class="hl-0"># use `env OPENAI_API_KEY=`</span><br><span class="hl-1">cat</span><span class="hl-2"> </span><span class="hl-4">/var/log/kernel.lo</span><br><span class="hl-1">cd</span><span class="hl-2"> </span><span class="hl-4">/tmp</span><br><span class="hl-1">echo</span><span class="hl-2"> </span><span class="hl-4">"Hello, world!"</span><span class="hl-2"> &gt; </span><span class="hl-4">hello.txt</span><br><span class="hl-1">chmod</span><span class="hl-2"> </span><span class="hl-5">700</span><span class="hl-2"> </span><span class="hl-4">hello.txt</span><br><span class="hl-1">chown</span><span class="hl-2"> </span><span class="hl-4">user</span><span class="hl-2"> </span><span class="hl-4">hello.txt</span><br><span class="hl-1">clear</span><br><span class="hl-1">cp</span><span class="hl-2"> </span><span class="hl-4">/tmp/hello.txt</span><span class="hl-2"> </span><span class="hl-4">/tmp/hi.txt</span><br><span class="hl-1">cron</span><span class="hl-2"> </span><span class="hl-4">add</span><span class="hl-2"> </span><span class="hl-4">"* * * * *"</span><span class="hl-2"> </span><span class="hl-4">"echo hello"</span><span class="hl-2"> </span><span class="hl-0"># add a cron job</span><br><span class="hl-1">cron</span><span class="hl-2"> </span><span class="hl-4">reload</span><span class="hl-2"> </span><span class="hl-0"># reload crontabs from files</span><br><span class="hl-1">cron</span><span class="hl-2"> </span><span class="hl-4">list</span><span class="hl-2"> </span><span class="hl-0"># list all cron jobs</span><br><span class="hl-1">download</span><span class="hl-2"> </span><span class="hl-4">hello.txt</span><br><span class="hl-1">edit</span><span class="hl-2"> </span><span class="hl-4">hello.txt</span><br><span class="hl-1">env</span><span class="hl-2"> </span><span class="hl-4">hello</span><span class="hl-2"> </span><span class="hl-3">--set</span><span class="hl-2"> </span><span class="hl-4">world</span><span class="hl-2"> ; </span><span class="hl-1">env</span><br><span class="hl-1">fetch</span><span class="hl-2"> </span><span class="hl-4">https://ipecho.net/plain</span><span class="hl-2"> &gt; </span><span class="hl-4">/tmp/myip.txt</span><br><span class="hl-1">fetch</span><span class="hl-2"> </span><span class="hl-3">-o</span><span class="hl-2"> </span><span class="hl-4">/tmp/initfs.tar.gz</span><span class="hl-2"> </span><span class="hl-4">/initfs.tar.gz</span><br><span class="hl-1">fetch</span><span class="hl-2"> </span><span class="hl-4">/initfs.tar.gz</span><span class="hl-2"> | </span><span class="hl-1">head</span><span class="hl-2"> | </span><span class="hl-1">hex</span><br><span class="hl-1">fetch</span><span class="hl-2"> </span><span class="hl-4">/xkcd-os.sixel</span><span class="hl-2"> </span><span class="hl-0"># xterm.js includes sixel support</span><br><span class="hl-1">fetch</span><span class="hl-2"> </span><span class="hl-4">/swapi/fs/home/user/hello.txt</span><span class="hl-2"> </span><span class="hl-0"># fetch a file from the filesystem</span><br><span class="hl-1">fetch</span><span class="hl-2"> </span><span class="hl-4">/swapi/fake/person/fullName</span><span class="hl-2"> </span><span class="hl-0"># fetch a random person from the SWAPI</span><br><span class="hl-1">install</span><span class="hl-2"> </span><span class="hl-4">jquery</span><br><span class="hl-1">install</span><span class="hl-2"> </span><span class="hl-4">@ecmaos-apps/boilerplate</span><br><span class="hl-1">ls</span><span class="hl-2"> </span><span class="hl-4">/dev</span><br><span class="hl-1">mkdir</span><span class="hl-2"> </span><span class="hl-4">/tmp/zip</span><span class="hl-2"> ; </span><span class="hl-1">cd</span><span class="hl-2"> </span><span class="hl-4">/tmp/zip</span><br><span class="hl-1">upload</span><br><span class="hl-1">mount</span><span class="hl-2"> </span><span class="hl-3">-t</span><span class="hl-2"> </span><span class="hl-4">zip</span><span class="hl-2"> </span><span class="hl-4">myuploaded.zip</span><span class="hl-2"> </span><span class="hl-4">/mnt/zip</span><br><span class="hl-1">cd</span><span class="hl-2"> </span><span class="hl-4">..</span><span class="hl-2"> ; </span><span class="hl-1">pwd</span><br><span class="hl-1">unzip</span><span class="hl-2"> </span><span class="hl-4">zip/myuploaded.zip</span><br><span class="hl-1">mv</span><span class="hl-2"> </span><span class="hl-4">zip/myuploaded.zip</span><span class="hl-2"> </span><span class="hl-4">/tmp/backup.zip</span><br><span class="hl-1">passwd</span><span class="hl-2"> </span><span class="hl-4">old</span><span class="hl-2"> </span><span class="hl-4">new</span><br><span class="hl-1">play</span><span class="hl-2"> </span><span class="hl-4">/root/test.mp3</span><br><span class="hl-1">ps</span><br><span class="hl-1">rm</span><span class="hl-2"> </span><span class="hl-4">/tmp/backup.zip</span><br><span class="hl-1">screensaver</span><br><span class="hl-1">snake</span><br><span class="hl-1">stat</span><span class="hl-2"> </span><span class="hl-4">/tmp/hello.txt</span><br><span class="hl-1">touch</span><span class="hl-2"> </span><span class="hl-4">/tmp/test.bin</span><br><span class="hl-1">umount</span><span class="hl-2"> </span><span class="hl-4">/mnt/zip</span><br><span class="hl-1">user</span><span class="hl-2"> </span><span class="hl-4">add</span><span class="hl-2"> </span><span class="hl-4">user</span><br><span class="hl-1">su</span><span class="hl-2"> </span><span class="hl-4">user</span><br><span class="hl-1">video</span><span class="hl-2"> </span><span class="hl-4">/root/video.mp4</span><br><span class="hl-1">zip</span><span class="hl-2"> </span><span class="hl-4">/root/tmp.zip</span><span class="hl-2"> </span><span class="hl-4">/tmp</span>
+</code><button type="button">Copy</button></pre>
+<a id="device-examples" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Device Examples<a href="#device-examples" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="sh"><span class="hl-1">/dev/audio</span><span class="hl-2"> </span><span class="hl-4">test</span><br><span class="hl-1">/dev/battery</span><span class="hl-2"> </span><span class="hl-4">status</span><br><span class="hl-1">/dev/bluetooth</span><span class="hl-2"> </span><span class="hl-4">scan</span><br><span class="hl-1">/dev/gamepad</span><span class="hl-2"> </span><span class="hl-4">list</span><br><span class="hl-1">/dev/geo</span><span class="hl-2"> </span><span class="hl-4">position</span><br><span class="hl-1">/dev/gpu</span><span class="hl-2"> </span><span class="hl-4">test</span><br><span class="hl-1">/dev/hid</span><span class="hl-2"> </span><span class="hl-4">list</span><br><span class="hl-1">/dev/midi</span><span class="hl-2"> </span><span class="hl-4">list</span><br><span class="hl-1">/dev/presentation</span><span class="hl-2"> </span><span class="hl-4">start</span><span class="hl-2"> </span><span class="hl-4">https://wikipedia.org</span><br><span class="hl-1">/dev/sensors</span><span class="hl-2"> </span><span class="hl-4">list</span><br><span class="hl-1">/dev/serial</span><span class="hl-2"> </span><span class="hl-4">devices</span><br><span class="hl-1">/dev/usb</span><span class="hl-2"> </span><span class="hl-4">list</span><br><span class="hl-1">/dev/webgpu</span><span class="hl-2"> </span><span class="hl-4">test</span><br><span class="hl-1">echo</span><span class="hl-2"> </span><span class="hl-4">"Goodbye"</span><span class="hl-2"> &gt; </span><span class="hl-4">/dev/null</span><br><span class="hl-1">echo</span><span class="hl-2"> </span><span class="hl-4">"This will error"</span><span class="hl-2"> &gt; </span><span class="hl-4">/dev/full</span><br><span class="hl-1">head</span><span class="hl-2"> </span><span class="hl-3">-c</span><span class="hl-2"> </span><span class="hl-5">32</span><span class="hl-2"> </span><span class="hl-4">/dev/random</span><span class="hl-2"> &gt; </span><span class="hl-4">/tmp/random.txt</span><br><span class="hl-1">head</span><span class="hl-2"> </span><span class="hl-3">-c</span><span class="hl-2"> </span><span class="hl-5">32</span><span class="hl-2"> </span><span class="hl-4">/dev/zero</span><span class="hl-2"> &gt; </span><span class="hl-4">/dev/null</span>
+</code><button type="button">Copy</button></pre>
+<a id="code-execution-example" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Code Execution Example<a href="#code-execution-example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="sh"><span class="hl-1">echo</span><span class="hl-2"> </span><span class="hl-4">"window.alert('Hello, world!')"</span><span class="hl-2"> &gt; </span><span class="hl-4">/root/hello.js</span><br><span class="hl-1">load</span><span class="hl-2"> </span><span class="hl-4">/root/hello.js</span>
+</code><button type="button">Copy</button></pre>
+<a id="scripting" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Scripting<a href="#scripting" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="txt">#!ecmaos:bin:script
+echo "Hello, world!"
+install jquery
+</code><button type="button">Copy</button></pre>
+<a id="startup" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Startup<a href="#startup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
+<li><code>/boot/init</code> is a script that runs on boot inside the init process (PID 0)</li>
+<li><code>/etc/crontab</code> is loaded on boot and contains system-wide scheduled tasks</li>
+<li><code>~/.config/crontab</code> is loaded on user login and contains user-specific scheduled tasks</li>
+<li><code>/etc/packages</code> is a list of already installed packages to load on boot; one per line</li>
+<li>The env var <code>ECMAOS_KERNEL_MODULES</code> is a list of modules to load on boot; CSV with pinned versions</li>
+<li>The env var <code>ECMAOS_RECOMMENDED_APPS</code> is a list of apps to suggest to new users</li>
+</ul>
+<a id="app-development" class="tsd-anchor"></a><h2 class="tsd-anchor-link">App Development<a href="#app-development" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The <a href="/apps">apps</a> directory in the repository contains some examples of how to develop apps, but there are many approaches you could take.</p>
+<ul>
+<li><code>@ecmaos-apps/boilerplate</code>: A minimal boilerplate app for reference</li>
+<li><code>@ecmaos-apps/code</code>: A simple code editor app using <a href="https://microsoft.github.io/monaco-editor/" target="_blank" class="external">Monaco</a>; serves as a good reference for more complex apps</li>
+</ul>
+<p>Basically, your app's <a href="https://docs.npmjs.com/cli/v10/configuring-npm/package-json#bin" target="_blank" class="external">bin</a> file has a <code>main</code> (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 <code>#!ecmaos:bin:app:myappname</code> is required at the top of the bin file to identify it as an app.</p>
+<a id="appkernel-interface-example" class="tsd-anchor"></a><h2 class="tsd-anchor-link">App/Kernel Interface Example<a href="#appkernel-interface-example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><blockquote>
+<p>See the <a href="https://docs.ecmaos.sh" target="_blank" class="external">docs</a> for more information</p>
+</blockquote>
+<pre><code class="ts"><span class="hl-0">#!ecmaos:bin:app:example</span><br><span class="hl-0">// shebang format: ecmaos:exectype:execnamespace:execname</span><br><span class="hl-6">export</span><span class="hl-2"> </span><span class="hl-6">default</span><span class="hl-2"> </span><span class="hl-3">async</span><span class="hl-2"> </span><span class="hl-3">function</span><span class="hl-2"> </span><span class="hl-1">main</span><span class="hl-2">(</span><span class="hl-7">params</span><span class="hl-2">: </span><span class="hl-8">ProcessEntryParams</span><span class="hl-2">) {</span><br><span class="hl-2">  </span><span class="hl-3">const</span><span class="hl-2"> { </span><span class="hl-9">args</span><span class="hl-2">, </span><span class="hl-9">kernel</span><span class="hl-2">, </span><span class="hl-9">terminal</span><span class="hl-2"> } = </span><span class="hl-7">params</span><br><span class="hl-2">  </span><span class="hl-7">kernel</span><span class="hl-2">.</span><span class="hl-7">log</span><span class="hl-2">.</span><span class="hl-1">info</span><span class="hl-2">(</span><span class="hl-4">'Hello, world!'</span><span class="hl-2">)</span><br><span class="hl-2">  </span><span class="hl-7">kernel</span><span class="hl-2">.</span><span class="hl-7">log</span><span class="hl-2">.</span><span class="hl-1">debug</span><span class="hl-2">(</span><span class="hl-7">args</span><span class="hl-2">)</span><br><span class="hl-2">  </span><span class="hl-7">terminal</span><span class="hl-2">.</span><span class="hl-1">writeln</span><span class="hl-2">(</span><span class="hl-4">'Hello, world!'</span><span class="hl-2">)</span><br><span class="hl-2">  </span><span class="hl-6">await</span><span class="hl-2"> </span><span class="hl-7">kernel</span><span class="hl-2">.</span><span class="hl-7">filesystem</span><span class="hl-2">.</span><span class="hl-7">fs</span><span class="hl-2">.</span><span class="hl-1">writeFile</span><span class="hl-2">(</span><span class="hl-4">'/tmp/hello.txt'</span><span class="hl-2">, </span><span class="hl-4">'Hello, world!'</span><span class="hl-2">)</span><br><span class="hl-2">  </span><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-9">win</span><span class="hl-2"> = </span><span class="hl-7">kernel</span><span class="hl-2">.</span><span class="hl-7">windows</span><span class="hl-2">.</span><span class="hl-1">create</span><span class="hl-2">({ </span><span class="hl-7">title:</span><span class="hl-2"> </span><span class="hl-4">'Example'</span><span class="hl-2">, </span><span class="hl-7">width:</span><span class="hl-2"> </span><span class="hl-5">800</span><span class="hl-2">, </span><span class="hl-7">height:</span><span class="hl-2"> </span><span class="hl-5">600</span><span class="hl-2"> })</span><br><span class="hl-2">  </span><span class="hl-3">const</span><span class="hl-2"> </span><span class="hl-9">container</span><span class="hl-2"> = </span><span class="hl-7">document</span><span class="hl-2">.</span><span class="hl-1">createElement</span><span class="hl-2">(</span><span class="hl-4">'div'</span><span class="hl-2">)</span><br><span class="hl-2">  </span><span class="hl-7">container</span><span class="hl-2">.</span><span class="hl-7">innerHTML</span><span class="hl-2"> = </span><span class="hl-4">'&lt;h1&gt;Hello, world!&lt;/h1&gt;'</span><br><span class="hl-2">  </span><span class="hl-7">win</span><span class="hl-2">.</span><span class="hl-1">mount</span><span class="hl-2">(</span><span class="hl-7">container</span><span class="hl-2">)</span><br><span class="hl-2">}</span>
+</code><button type="button">Copy</button></pre>
+<a id="early-days" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Early Days<a href="#early-days" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>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.</p>
+<p>Things to keep in mind:</p>
+<ul>
+<li>If things go wrong or break, clear your browser cache and site data for ecmaOS</li>
+<li>Things have changed a lot since the tests were written, so they need to be updated and fixed</li>
+<li>The kernel is designed to be run in an environment with a DOM (i.e. a browser)</li>
+<li>Many features are only available on Chromium-based browsers, and many more behind feature flags</li>
+<li>There will be a lot of technical challenges to overcome, and many things will first be implemented in a non-optimal way</li>
+<li>Command interfaces won't match what you might be used to from a traditional Linux environment; not all commands and options are supported. Over time, Linuxish commands will be fleshed out and made to behave in a more familiar way.</li>
+<li>Globbing doesn't work in the terminal yet, <a href="https://zenfs.dev/core/functions/fs.promises.glob.html" target="_blank" class="external">but is supported at the filesystem level</a></li>
+</ul>
+<a id="development" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Development<a href="#development" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p><a href="https://turbo.build/repo" target="_blank" class="external">Turborepo</a> is used to manage the monorepo, and <a href="https://pnpm.io" target="_blank" class="external">pnpm</a> is used for package management.</p>
+<p>PNPM Workspaces:</p>
+<ul>
+<li><a href="/apps">apps</a></li>
+<li><a href="/core">core</a></li>
+<li><a href="/devices">devices</a></li>
+<li><a href="/modules">modules</a></li>
+<li><a href="/utils">utils</a></li>
+</ul>
+<p>A good place to start is viewing the <code>scripts</code> property of <a href="media/package.json">package.json</a> in the root of the repository.</p>
+<pre><code class="bash"><span class="hl-0"># Clone</span><br><span class="hl-1">git</span><span class="hl-2"> </span><span class="hl-4">clone</span><span class="hl-2"> </span><span class="hl-4">https://github.com/ecmaos/ecmaos.git</span><br><br><span class="hl-0"># Install dependencies</span><br><span class="hl-1">cd</span><span class="hl-2"> </span><span class="hl-4">ecmaos</span><span class="hl-2"> &amp;&amp; </span><span class="hl-1">pnpm</span><span class="hl-2"> </span><span class="hl-4">install</span><br><br><span class="hl-0"># Run the dev server</span><br><span class="hl-1">pnpm</span><span class="hl-2"> </span><span class="hl-4">run</span><span class="hl-2"> </span><span class="hl-4">dev:kernel</span><br><br><span class="hl-0"># Run the docs server (optional)</span><br><span class="hl-1">pnpm</span><span class="hl-2"> </span><span class="hl-4">run</span><span class="hl-2"> </span><span class="hl-4">dev:docs</span><br><br><span class="hl-0"># Build</span><br><span class="hl-1">pnpm</span><span class="hl-2"> </span><span class="hl-4">run</span><span class="hl-2"> </span><span class="hl-4">build</span><br><br><span class="hl-0"># Run tests</span><br><span class="hl-1">pnpm</span><span class="hl-2"> </span><span class="hl-4">run</span><span class="hl-2"> </span><span class="hl-4">test</span><br><span class="hl-1">pnpm</span><span class="hl-2"> </span><span class="hl-4">run</span><span class="hl-2"> </span><span class="hl-4">test:watch</span><br><span class="hl-1">pnpm</span><span class="hl-2"> </span><span class="hl-4">run</span><span class="hl-2"> </span><span class="hl-4">test:coverage</span><br><span class="hl-1">pnpm</span><span class="hl-2"> </span><span class="hl-4">run</span><span class="hl-2"> </span><span class="hl-4">test:bench</span><br><span class="hl-1">pnpm</span><span class="hl-2"> </span><span class="hl-4">run</span><span class="hl-2"> </span><span class="hl-4">test:ui</span><br><br><span class="hl-0"># Generate modules</span><br><span class="hl-1">turbo</span><span class="hl-2"> </span><span class="hl-4">gen</span><span class="hl-2"> </span><span class="hl-4">app</span><span class="hl-2"> </span><span class="hl-0"># generate a new app template</span><br><span class="hl-1">turbo</span><span class="hl-2"> </span><span class="hl-4">gen</span><span class="hl-2"> </span><span class="hl-4">device</span><span class="hl-2"> </span><span class="hl-0"># generate a new device template</span><br><span class="hl-1">turbo</span><span class="hl-2"> </span><span class="hl-4">gen</span><span class="hl-2"> </span><span class="hl-4">module</span><span class="hl-2"> </span><span class="hl-0"># generate a new module template</span>
+</code><button type="button">Copy</button></pre>
+<p>Also see <a href="media/turbo.json">turbo.json</a> and <a href="/CONTRIBUTING.md">CONTRIBUTING.md</a> for more information.</p>
+<a id="security-vulnerabilities" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Security Vulnerabilities<a href="#security-vulnerabilities" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>See <a href="/SECURITY.md">SECURITY.md</a> for more information.</p>
+<p>If you find a serious security vulnerability, please submit a new <a href="https://github.com/ecmaos/ecmaos/security" target="_blank" class="external">Draft Security Advisory</a> or contact the project maintainer directly at <a href="mailto:code@mathis.network">code@mathis.network</a>.</p>
+</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked=""><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open="" class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details" tabindex="-1"><a href="#the-web-kernel"><span>The <wbr>Web <wbr>Kernel</span></a><ul><li><a href="#features"><span>Features</span></a></li><li><a href="#basic-concepts"><span>Basic <wbr>Concepts</span></a></li><li><ul><li><a href="#apps"><span>Apps</span></a></li><li><a href="#commands"><span>Commands</span></a></li><li><a href="#coreutils"><span>Coreutils</span></a></li><li><a href="#devices"><span>Devices</span></a></li><li><a href="#filesystems"><span>Filesystems</span></a></li><li><ul><li><a href="#supported-filesystem-types"><span>Supported <wbr>Filesystem <wbr>Types</span></a></li><li><a href="#basic-usage"><span>Basic <wbr>Usage</span></a></li><li><a href="#etcfstab"><span>/etc/fstab</span></a></li></ul></li><li><a href="#generators"><span>Generators</span></a></li><li><a href="#kernel"><span>Kernel</span></a></li><li><a href="#metal"><span>Metal</span></a></li><li><a href="#modules"><span>Modules</span></a></li><li><a href="#packages"><span>Packages</span></a></li><li><a href="#sockets"><span>Sockets</span></a></li><li><a href="#swapi"><span>SWAPI</span></a></li><li><a href="#telemetry"><span>Telemetry</span></a></li><li><a href="#utils"><span>Utils</span></a></li></ul></li><li><a href="#important-files-and-directories"><span>Important <wbr>Files and <wbr>Directories</span></a></li><li><a href="#command-examples"><span>Command <wbr>Examples</span></a></li><li><a href="#device-examples"><span>Device <wbr>Examples</span></a></li><li><a href="#code-execution-example"><span>Code <wbr>Execution <wbr>Example</span></a></li><li><a href="#scripting"><span>Scripting</span></a></li><li><a href="#startup"><span>Startup</span></a></li><li><a href="#app-development"><span>App <wbr>Development</span></a></li><li><a href="#appkernel-interface-example"><span>App/<wbr>Kernel <wbr>Interface <wbr>Example</span></a></li><li><a href="#early-days"><span>Early <wbr>Days</span></a></li><li><a href="#development"><span>Development</span></a></li><li><a href="#security-vulnerabilities"><span>Security <wbr>Vulnerabilities</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current">ecmaOS</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a> with the <a href="https://www.npmjs.com/package/@typhonjs-typedoc/typedoc-theme-dmt" target="_blank">Default Modern Theme</a></p></footer></main></body></html>