Skip to content

README.md

Latest commit

 

History

History
114 lines (72 loc) · 2.24 KB

README.md

File metadata and controls

114 lines (72 loc) · 2.24 KB

OllieOS on Node.js

A terminal-based port of OllieOS, running via a Node.js wrapper.

Goals

  • Provide a near-complete terminal version of the OllieOS website.
  • Enable package testing and development within the environment.
  • Integrate with the real filesystem for seamless editing.
  • Polyfill browser features using Node.js, without full DOM emulation.

Installation

git clone https://github.com/obfuscatedgenerated/ollieos_node.git
cd ollieos_node
npm install

Running

Start the OS:

npm start

For best results, use a modern terminal with support for ANSI escape codes and Sixel graphics (e.g. Windows Terminal).

To start without clearing the terminal (useful for debugging):

npm run start:no-clear

Node-Specific Programs

The Node.js wrapper provides additional utilities available within the OS:

Adding ollieos to Your PATH

Use npm link to make ollieos globally available:

npm link

Now you can run it from anywhere:

ollieos

Pass --no-clear to skip terminal clearing:

ollieos --no-clear

You can pipe commands split by newlines into OllieOS:

echo "cat credits.txt" | ollieos

To remove the global link:

npm rm --global ollieos_node

Updating

To update both the wrapper and OS:

git pull origin main
npm install

Updating Only the OS

npm update ollieos

Or use the update program built into the OS and restart.

Editing Files

OllieOS ships with the RealFS filesystem implementation. Files are stored in your real OS's app data directory:

  • Windows: %APPDATA%/ollieos
  • macOS: ~/Library/Application Support/ollieos
  • Linux: ~/.config/ollieos

To open the fs directory in your file explorer from within OllieOS, use the appdata program.

You can directly edit these files, and changes will reflect in OllieOS.

Note: Files should use CRLF line endings. No conversion is done to avoid corrupting binary files.