{"id":18559048,"url":"https://github.com/linux-china/xtermjs-spring-boot-starter","last_synced_at":"2025-04-10T02:30:37.619Z","repository":{"id":49034725,"uuid":"234659545","full_name":"linux-china/xtermjs-spring-boot-starter","owner":"linux-china","description":"Web terminal to manage your Spring Boot app","archived":false,"fork":false,"pushed_at":"2024-01-09T15:15:35.000Z","size":620,"stargazers_count":34,"open_issues_count":0,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-02T02:51:15.828Z","etag":null,"topics":["rsocket","spring-boot","spring-shell","xtermjs"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/linux-china.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}},"created_at":"2020-01-18T00:26:16.000Z","updated_at":"2024-07-17T02:46:26.000Z","dependencies_parsed_at":"2024-01-09T16:46:09.132Z","dependency_job_id":null,"html_url":"https://github.com/linux-china/xtermjs-spring-boot-starter","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linux-china%2Fxtermjs-spring-boot-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linux-china%2Fxtermjs-spring-boot-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linux-china%2Fxtermjs-spring-boot-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linux-china%2Fxtermjs-spring-boot-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/linux-china","download_url":"https://codeload.github.com/linux-china/xtermjs-spring-boot-starter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248144155,"owners_count":21054876,"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":["rsocket","spring-boot","spring-shell","xtermjs"],"created_at":"2024-11-06T21:41:55.726Z","updated_at":"2025-04-10T02:30:37.209Z","avatar_url":"https://github.com/linux-china.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"xtermjs-spring-boot-starter\n===========================\n[![Build Status](https://api.travis-ci.com/linux-china/xtermjs-spring-boot-starter.svg?branch=master)](https://travis-ci.com/linux-china/xtermjs-spring-boot-starter)\n\n\nSupply a web terminal to manage Spring Boot app. Why?\n\n* Access easy: not install, no env setup, just open the browser\n* Use commands to manage app\n* No need to us curl to call lots of REST API\n* Easy to write commands by Spring Shell\n\n![Xterm Console](console.png)\n\n**Attention**: You should care about security by yourself.\n\n# How to use?\n\n* Edit pom.xml and add following dependency:\n\n```xml\n\u003cdependencies\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003eorg.mvnsearch\u003c/groupId\u003e\n        \u003cartifactId\u003extermjs-spring-boot-starter\u003c/artifactId\u003e\n        \u003cversion\u003e1.3.1\u003c/version\u003e\n    \u003c/dependency\u003e \n\u003c/dependencies\u003e \n```\n\n* Open application.properties and add rsocket configuration.\n\n```properties\n# rsocket websocket\nspring.rsocket.server.mapping-path=/rsocket\nspring.rsocket.server.transport=websocket\n# disable spring shell interactive mode \nspring.shell.interactive.enabled=false\n```\n\n* Start Spring Boot app and visit http://localhost:8080/xterm\n\n\n# Terminal Features\n\n* History: arrow up/down\n* Ctrl+U: clear input\n* clear: clear the screen\n* exit: close the window/tab\n\n# Application commands\n\n### System commands\n\n* cd, ls, tree etc. support by ZT Process Executor\n\n### System\n\n* date\n* curl: curl command for http operation\n\n### JVM commands\n\n* threads: display threads\n* classpath: display classpath\n\n### Spring Commands\n* Help: Spring Shell help\n* app: display app information\n* beans: display all spring beans\n* bean: display bean definition\n* profiles: display profile\n* metrics: display metrics\n* health: display health information\n* spel: execute SpEL expression 'spel userService.findById(1)'\n* actuator: display actuator information\n\n### Commands for Spring Bean\n\n* redis commands\n\n```\nuse redis\nset nick linux_china\nget nick\nexit\n```\n\n* mysql commands\n\n```\nuse db\nselect * from account;\nexit db\n```\n\n# How to development\n\n* Start Spring Boot App to supply xterm backend service\n* Start \"npm run start\" to start Webpack dev server for JavaScript development\n\n# References\n\n* Xterm.js Home: https://xtermjs.org/\n* Spring Shell Docs: https://docs.spring.io/spring-shell/docs/current/reference/htmlsingle/\n* xterm.js + local echo https://www.linkedin.com/pulse/xtermjs-local-echo-ioannis-charalampidis\n* How to change the output color of echo in Linux: https://stackoverflow.com/questions/5947742/how-to-change-the-output-color-of-echo-in-linux\n* NO_COLOR: https://no-color.org/\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinux-china%2Fxtermjs-spring-boot-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flinux-china%2Fxtermjs-spring-boot-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinux-china%2Fxtermjs-spring-boot-starter/lists"}