viveksb007 / rest-based-shell

This project emulates the shell using REST

rest-based-shell

This project is intended to be able to run commands where your application is hosted if a terminal is not exposed to you.

This REST based application simply takes the command and executes using shell. I tried to emulate real behaviour of system shell. So added a username parameter, this differentiates the directory state of each shell. Using the endpoint with different usernames is similar to using two terminal windows.

Development

To run it locally simply clone the project and run gradle clean build and run the jar from build/libs folder.

If you are using IntelliJ, just import the project and run main() of ApplicationKt

After application is up and running, you can head over to localhost:8080 (username,password -> admin, admin)

Screenshot

Contribution

Feel free to checkout the project, submit issues and enhancement requests.

rest-based-shell's Issues

Decouple shell functionality as a library

Abstract out shell functionality and include that as a dependency. Then use that library API over REST endpoints.

add exit command for terminating user sesssions

currently, once a shell instance is created using a USERNAME, then its retained in memory as long as application is up.
There should be some expiration logic like using exit command to kill shell session or some time based session termination.

convert it into a library

convert and publish it as a library which can be integrated and initialized in other Applications.
Need to look for integration with different frameworks like Spring-Boot and Sparkjava