Skip to content

@prozilla-os/terminal

About

@prozilla-os/terminal is a terminal/shell application for ProzillaOS.

Installation

@prozilla-os/core is required to run this application.

sh
$ npm install @prozilla-os/core @prozilla-os/terminal
$ yarn add @prozilla-os/core @prozilla-os/terminal
$ pnpm add @prozilla-os/core @prozilla-os/terminal

Usage

Basic setup

tsx
import { Desktop, ModalsView, ProzillaOS, Taskbar, WindowsView, AppsConfig } from "@prozilla-os/core";
import { terminal } from "@prozilla-os/terminal";

function App() {
  return (
    <ProzillaOS
      systemName="Example"
      tagLine="Powered by ProzillaOS"
      config={{
        apps: new AppsConfig({
          apps: [ terminal ]
        })
      }}
    >
      <Taskbar/>
      <WindowsView/>
      <ModalsView/>
      <Desktop/>
    </ProzillaOS>
  );
}

Window options

tsx
/**
 * Initial path that the app will open
 * @default "~" - Home directory
 */
path: string;

/**
 * Initial input
 */
input: string;

Built by Prozilla