Skip to content
/ yaet Public
forked from HeyPuter/yaet

Yet Another Electron Terminal

License

Notifications You must be signed in to change notification settings

snowyu/yaet

 
 

Repository files navigation

YAET

YAET: Another Terminal Emulator

YAET is a terminal that can display web pages.

screenshot


❓ What is this?

YAET is a terminal emulator built on Xterm.js and Electron. It can interpret escape sequences that allow shell scripts and other programs to write HTML content directly to the terminal, or display content from the web.

⚠️ Security Implications

This application is experimental and you should only use it with scripts and programs that you trust. While the security mechanisms in Chromium will prevent the iframe from doing anything crazy of its own accord, it's important to be mindful of click-jacking, tracking the client, and any vulnerabilities that might be discovered in the future.


📦 Setup

You will need to run npm install. You may also need to run electron-rebuild within src/application.

npm install
cd src/application
npx electron-rebuild -f -w node-pty
cd -

You will need to run rollup inside src/terminal.

cd src/terminal
rollup -c rollup.config.js --watch

▶️ Run

After following the steps above, running npm start inside src/application should launch YAET.

cd src/application
npm run start

📚 Docs


🌐 Similar Projects

  • DomTerm can also render HTML via an escape sequence. This terminal emulator is more mature than YAET, so if you're looking for a daily driver this might be a better choice.

About

Yet Another Electron Terminal

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 57.4%
  • TypeScript 39.7%
  • CSS 1.1%
  • HTML 1.1%
  • Shell 0.7%