{"id":28446922,"url":"https://github.com/os-js/osjs-xterm-application","last_synced_at":"2025-06-30T06:32:44.928Z","repository":{"id":31393002,"uuid":"123693244","full_name":"os-js/osjs-xterm-application","owner":"os-js","description":"OS.js Xterm Application","archived":false,"fork":false,"pushed_at":"2022-08-09T22:52:55.000Z","size":94,"stargazers_count":20,"open_issues_count":1,"forks_count":15,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-06-06T11:08:46.539Z","etag":null,"topics":["osjs","osjs-application"],"latest_commit_sha":null,"homepage":"https://manual.os-js.org/v3/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/os-js.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"andersevenrud","patreon":"andersevenrud","open_collective":"osjs","liberapay":"os-js","custom":"https://paypal.me/andersevenrud"}},"created_at":"2018-03-03T13:13:58.000Z","updated_at":"2025-05-09T10:12:31.000Z","dependencies_parsed_at":"2022-07-25T01:32:18.638Z","dependency_job_id":null,"html_url":"https://github.com/os-js/osjs-xterm-application","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"purl":"pkg:github/os-js/osjs-xterm-application","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/os-js%2Fosjs-xterm-application","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/os-js%2Fosjs-xterm-application/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/os-js%2Fosjs-xterm-application/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/os-js%2Fosjs-xterm-application/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/os-js","download_url":"https://codeload.github.com/os-js/osjs-xterm-application/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/os-js%2Fosjs-xterm-application/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260988559,"owners_count":23093518,"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":["osjs","osjs-application"],"created_at":"2025-06-06T11:08:46.887Z","updated_at":"2025-06-30T06:32:44.886Z","avatar_url":"https://github.com/os-js.png","language":"JavaScript","funding_links":["https://github.com/sponsors/andersevenrud","https://patreon.com/andersevenrud","https://opencollective.com/osjs","https://liberapay.com/os-js","https://paypal.me/andersevenrud","https://www.patreon.com/user?u=2978551\u0026ty=h\u0026u=2978551","https://liberapay.com/os-js/"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"OS.js Logo\" src=\"https://raw.githubusercontent.com/os-js/gfx/master/logo-big.png\" /\u003e\n\u003c/p\u003e\n\n[OS.js](https://www.os-js.org/) is an [open-source](https://raw.githubusercontent.com/os-js/OS.js/master/LICENSE) web desktop platform with a window manager, application APIs, GUI toolkit, filesystem abstractions and much more.\n\n[![Support](https://img.shields.io/badge/patreon-support-orange.svg)](https://www.patreon.com/user?u=2978551\u0026ty=h\u0026u=2978551)\n[![Support](https://img.shields.io/badge/opencollective-donate-red.svg)](https://opencollective.com/osjs)\n[![Donate](https://img.shields.io/badge/liberapay-donate-yellowgreen.svg)](https://liberapay.com/os-js/)\n[![Donate](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://paypal.me/andersevenrud)\n[![Community](https://img.shields.io/badge/join-community-green.svg)](https://community.os-js.org/)\n\n# OS.js v3 Xterm Application\n\nThis is the Xterm Application for OS.js v3\n\n![Screenshot](https://raw.githubusercontent.com/os-js/osjs-xterm-application/master/screenshot.png)\n\n## Requirements\n\n* `bash`\n* `ssh`\n\n## Installation\n\n```bash\nnpm install --save --production @osjs/xterm-application\nnpm run package:discover\n```\n\n# Usage\n\nStart from application menu.\n\n**Note that it will log into a shell with the username you are logged in as.**\n\nIf you want to change this behavior, you can add this to your `src/server/config.js` file in the OS.js distribution:\n\n```javascript\nmodule.exports = {\n  // ... append this to your export ...\n  xterm: {\n    // You can also set this as a string to force a username\n    login: false\n  }\n}\n```\n\nYou can also change the connection arguments:\n\n```javascript\nmodule.exports = {\n  // ... append this to your export ...\n  xterm: {\n    ssh: {\n      // Custom hostname\n      hostname: 'localhost',\n\n      // Custom port\n      args: '-p 1022'\n    }\n  }\n}\n```\n\n## Contribution\n\n* **Sponsor on [Github](https://github.com/sponsors/andersevenrud)**\n* **Become a [Patreon](https://www.patreon.com/user?u=2978551\u0026ty=h\u0026u=2978551)**\n* **Support on [Open Collective](https://opencollective.com/osjs)**\n* [Contribution Guide](https://github.com/os-js/OS.js/blob/master/CONTRIBUTING.md)\n\n## Documentation\n\nSee the [Official Manuals](https://manual.os-js.org/) for articles, tutorials and guides.\n\n## Links\n\n* [Official Chat](https://gitter.im/os-js/OS.js)\n* [Community Forums and Announcements](https://community.os-js.org/)\n* [Homepage](https://os-js.org/)\n* [Twitter](https://twitter.com/osjsorg) ([author](https://twitter.com/andersevenrud))\n* [Google+](https://plus.google.com/b/113399210633478618934/113399210633478618934)\n* [Facebook](https://www.facebook.com/os.js.org)\n* [Docker Hub](https://hub.docker.com/u/osjs/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fos-js%2Fosjs-xterm-application","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fos-js%2Fosjs-xterm-application","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fos-js%2Fosjs-xterm-application/lists"}