https://github.com/skyfallwastaken/phantom

https://github.com/skyfallwastaken/phantom

Last synced: 23 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/skyfallwastaken/phantom
• Owner: SkyfallWasTaken
• License: mit
• Created: 2024-07-08T19:40:07.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-08-28T20:16:31.000Z (2 months ago)
• Last Synced: 2024-08-29T13:43:07.062Z (2 months ago)
• Language: TypeScript
• Size: 207 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Phantom - A fantasy OS written in TypeScript

**Phantom** is a fantasy OS for the web, modeled upon Unix, Bash, and POSIX.

## Commands

```text

        echo - displays some text

        help - displays information about builtin commands

          cd - change the shell working directory

       mkdir - create a new directory

          ls - list info about files

       clear - clear the terminal

  ghostfetch - show system information

       touch - create a new file

      cowsay - cow says moo!

       about - info about phantom

         cat - print file to standard output

      python - run a python script

```

## Features

### In-browser Python support

Phantom supports Python scripts - and they run in the browser!

![output of `python fizzbuzz.png`](https://github.com/SkyfallWasTaken/phantom/blob/main/readme-images/fizzbuzz.png?raw=true)

This uses Pyodide under the hood. Pyodide is only loaded if you use the `python` command.

### Persistent filesystem

Phantom has a persistent filesystem (powered by IndexedDB), as well as commands to help you use it, such as `cd`, `cat`, `mkdir`, and `touch`.

![output of `cat README.md`](https://github.com/SkyfallWasTaken/phantom/blob/main/readme-images/cat.png?raw=true)

### "Did You Mean?" suggestions

If you make a typo in a command, Phantom's got your back - it'll automatically provide a suggestion that may be relevant.

![did you mean "about"?](https://github.com/SkyfallWasTaken/phantom/blob/main/readme-images/dym.png?raw=true)

Under the hood, Phantom uses the [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) to find the closest command in its registry.

### Pretty command prompt

Phantom has a cool command prompt, inspired by [Starship!](https://starship.rs)

![command prompt](https://github.com/SkyfallWasTaken/phantom/blob/main/readme-images/prompt.png?raw=true)

---

_© 2024 Mahad Kalam_

_Licensed under the [MIT License](LICENSE.md)_