{"id":19118801,"url":"https://github.com/heyputer/yaet","last_synced_at":"2025-05-05T04:17:55.252Z","repository":{"id":249735766,"uuid":"831944046","full_name":"HeyPuter/yaet","owner":"HeyPuter","description":"Yet Another Electron Terminal","archived":false,"fork":false,"pushed_at":"2024-07-23T19:41:08.000Z","size":457,"stargazers_count":22,"open_issues_count":7,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-05T04:17:49.603Z","etag":null,"topics":["electron","javascript","linux","node-js","nodejs","terminal","terminal-emulator","typescript","xterm-js","xtermjs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HeyPuter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-22T03:22:51.000Z","updated_at":"2025-03-13T03:41:34.000Z","dependencies_parsed_at":"2024-07-23T03:24:42.759Z","dependency_job_id":null,"html_url":"https://github.com/HeyPuter/yaet","commit_stats":null,"previous_names":["heyputer/yaet"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HeyPuter%2Fyaet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HeyPuter%2Fyaet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HeyPuter%2Fyaet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HeyPuter%2Fyaet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HeyPuter","download_url":"https://codeload.github.com/HeyPuter/yaet/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252436591,"owners_count":21747473,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["electron","javascript","linux","node-js","nodejs","terminal","terminal-emulator","typescript","xterm-js","xtermjs"],"created_at":"2024-11-09T05:07:45.332Z","updated_at":"2025-05-05T04:17:55.175Z","avatar_url":"https://github.com/HeyPuter.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch3 align=\"center\"\u003eYAET\u003c/h3\u003e\n\u003ch4 align=\"center\"\u003eYAET: Another Terminal Emulator\u003c/h4\u003e\n\n\u003cp align=\"center\"\u003e\nYAET is a terminal that can display web pages.\n\u003c/p\u003e\n\n\u003ch3 align=\"center\"\u003e\u003cimg width=\"800\" style=\"border-radius:5px;\" alt=\"screenshot\" src=\"https://assets.puter.site/yaet.webp\"\u003e\u003c/h3\u003e\n\n\u003chr\u003e\n\n### ❓ What is this?\n\nYAET is a terminal emulator built on Xterm.js and Electron.\nIt 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.\n\n### ⚠️ Security Implications\n\nThis application is **experimental** and you should only use it with scripts and programs\nthat you trust. While the security mechanisms in Chromium will prevent the iframe from\ndoing anything crazy of its own accord, it's important to be mindful of\n**click-jacking**, **tracking the client**, and any **vulnerabilities** that might be\ndiscovered in the future.\n\n- See [Security.md](./doc/Security.md) for more information.\n- See [PostMessageAPI.md](./doc/PostMessageAPI.md) to see what/when\n  communication is allowed to/from iframes.\n\n\u003cbr\u003e\n\n### 📦 Setup\n\nYou will need to run `npm install`. You may also need to run `electron-rebuild`\nwithin `src/application`.\n\n```\nnpm install\ncd src/application\nnpx electron-rebuild -f -w node-pty\ncd -\n```\n\nYou will need to run `rollup` inside `src/terminal`.\n\n```\ncd src/terminal\nrollup -c rollup.config.js --watch\n```\n\n\u003cbr\u003e\n\n### ▶️ Run\n\nAfter following the steps above, running `npm start`\ninside `src/application` should launch YAET.\n\n```\ncd src/application\nnpm run start\n```\n\n\u003cbr\u003e\n\n\n### 📚 Docs\n\n- [Configuring YAET](./doc/Configuration.md)\n- [YAET OSC Extensions](./doc/OSC.md)\n\n\u003cbr\u003e\n\n### 🌐 Similar Projects\n\n- [DomTerm](https://domterm.org/Wire-byte-protocol.html)\n  can also render HTML via [an escape sequence](https://domterm.org/Wire-byte-protocol.html).\n  This terminal emulator is more mature than YAET, so if you're looking for a daily driver\n  this might be a better choice.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheyputer%2Fyaet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fheyputer%2Fyaet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheyputer%2Fyaet/lists"}