{"id":36419434,"url":"https://github.com/jeeshell/je2sh","last_synced_at":"2026-01-11T17:04:55.508Z","repository":{"id":56770378,"uuid":"95458418","full_name":"jeeshell/je2sh","owner":"jeeshell","description":"JVM Extensible \u0026 Embeddable Shell","archived":false,"fork":false,"pushed_at":"2018-03-23T18:24:23.000Z","size":125,"stargazers_count":13,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-15T05:53:30.720Z","etag":null,"topics":["java","jcommander","jline","kotlin","shell","spring-boot","ssh"],"latest_commit_sha":null,"homepage":"https://jeeshell.github.io/je2sh/","language":"Java","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/jeeshell.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-26T14:58:05.000Z","updated_at":"2024-04-04T08:39:23.000Z","dependencies_parsed_at":"2022-08-16T02:20:42.791Z","dependency_job_id":null,"html_url":"https://github.com/jeeshell/je2sh","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/jeeshell/je2sh","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeeshell%2Fje2sh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeeshell%2Fje2sh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeeshell%2Fje2sh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeeshell%2Fje2sh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jeeshell","download_url":"https://codeload.github.com/jeeshell/je2sh/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeeshell%2Fje2sh/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28314264,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-11T14:58:17.114Z","status":"ssl_error","status_checked_at":"2026-01-11T14:55:53.580Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["java","jcommander","jline","kotlin","shell","spring-boot","ssh"],"created_at":"2026-01-11T17:04:54.878Z","updated_at":"2026-01-11T17:04:55.496Z","avatar_url":"https://github.com/jeeshell.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# This is JeeSh \n\n[![Build Status](https://travis-ci.org/jeeshell/je2sh.svg?branch=master)](https://travis-ci.org/jeeshell/je2sh)\n[![CodeFactor](https://www.codefactor.io/repository/github/hartimer/je2sh/badge)](https://www.codefactor.io/repository/github/hartimer/je2sh)\n\nJeeSh stands for \"JVM Extensible \u0026 Embeddable Shell\". It aims at being a reboot of the famous\n[Common Reusable SHell (CRaSH)](https://github.com/crashub/crash).\n \n \n## Motivation\n\nCRaSH is no longer maintained and [Spring Boot](https://projects.spring.io/spring-boot/) is removing support\nfor it with release 2.0. Having the ability to access Spring features through SSH is very handy, especially\nfor administrative tasks.\n\n\nWe envisioned three common use-cases:\n* **Standalone shell**. Useful for encoding utilities\n* **SSH Server**. If you want to have JeeSh running on your server providing functionality not available \non a normal *nix shell or for embedding it into a [Spring](https://spring.io/) application (common use case for CRaSH)\n* **REST Endpoints**. Allows you to expose your commands through a REST API, making it easy to create both \na healthy repertoire of features and a client layer (other than SSH) to interact with it. The *examples* project\nprovides a sample on how to use [JQueryTerminal](http://terminal.jcubic.pl/) for this purpose.\n\n\n# First Steps\n\nYou can check JeeSh in action right after checking out the project. The **examples** module is a Spring Boot app\nthat bootstraps JeeSh as both a SSH server and a REST API endpoint. Just run `./gradlew :examples:bootRun`\nand navigate to [http://localhost:8080/](http://localhost:8080/) or run `ssh -p 2003 admin@localhost` (admin:admin).\n\n\nTry the `help` command.\n \n\n## First Command\n\nJeeSh just takes advantage of [JCommander](http://jcommander.org/) for command specification. Here is\nthe entire code of the built in `hello` command\n \n```java\n@Parameters(commandNames = {\"hello\", \"hi\"} , commandDescription = \"Just says hello\")\npublic class Hello extends AbstractCommand {\n\n    @Parameter(names = {\"-n\", \"--name\"}, description = \"Your name\")\n    private String name;\n\n    @Override\n    public void execute(@NotNull CommandContext context) {\n        context.println(\"Hello \" + Optional.ofNullable(name).orElse(\"World\"));\n    }\n\n}\n```\n\nThe requirements:\n* Annotate your command with `@Parameters`\n* Implement `Command`. You will typically extend `net.je2sh.core.AbstractCommand` for convenience.\n\n\n# Architecture\n\nJeeSh is broken down into multiple modules, allowing users to only import what they need.\nBy design, and for experimentation purposes, it is built using Java 8 and Kotlin.\n\n\nThe base idea is that you can just define your commands using [JCommander](http://jcommander.org/) and those\nwill be automatically picked up by JeeSh (if [*annotations*](#annotations) module is used).\n\n\nFor parsing and rendering we use [jline3](https://github.com/jline/jline3), which allows using ANSI encodings\nand overall makes life easier.\n\n\n## Core\n\nThe core module provides the basis for everything else. Necessary interfaces and glue to interconnect\nthe different components that build JeeSh.\n\n## Annotations\n\nEnables *the magic* of interpreting `@Parameters`.\n\n\nThis module provides an annotation processor that creates a `CommandProvider` for you and makes it\navailable as a `ServiceProvider` (`META-INF/services`) which is how **core** loads the available commands.\n\n\nMode on this subject later on.\n\n\n## Base Plugins\n\nSmall set of builtin plugins. Function mostly as an reference but also includes the `help` command.\n\n## Shell\n\nStandalone shell instant that can be executed from the terminal\n\n## SSH\n\nPretty much self-explanatory.\n\n## Spring (Boot)\n\nWhen included this module autoconfigures JeeSh according the the properties you define. By default\nboth a SSH Server and a REST API will be enabled. These however can be controlled through the properties:\n`jeesh.ssh.enabled` and `jeesh.rest.enabled` respectively (to be added on your `application.[properties|yaml]`).\n\n# Disclaimer\n\nThis is definitely a work in progress so there is definitely a lot of room for improvement. If you want\nto contribute go ahead and grab an issued or submitted your awesome new feature!\n\nLicensed under the MIT License ([LICENSE](LICENSE.md))\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeeshell%2Fje2sh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjeeshell%2Fje2sh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeeshell%2Fje2sh/lists"}