{"id":20556253,"url":"https://github.com/teoneag/simple-cli-for-java","last_synced_at":"2026-06-05T19:31:33.950Z","repository":{"id":239230207,"uuid":"798291365","full_name":"Teoneag/Simple-CLI-for-Java","owner":"Teoneag","description":"A simple library for an interactive CLI.","archived":false,"fork":false,"pushed_at":"2024-10-07T19:01:55.000Z","size":247,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-06T06:48:12.847Z","etag":null,"topics":["cli","interractive","java","simple"],"latest_commit_sha":null,"homepage":"","language":"Java","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/Teoneag.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-05-09T13:38:42.000Z","updated_at":"2024-10-07T19:01:58.000Z","dependencies_parsed_at":"2024-05-10T21:27:30.134Z","dependency_job_id":"a0f7bc30-9c0a-4c1a-8b00-ebbca142996d","html_url":"https://github.com/Teoneag/Simple-CLI-for-Java","commit_stats":null,"previous_names":["teoneag/simple-cli"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Teoneag/Simple-CLI-for-Java","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Teoneag%2FSimple-CLI-for-Java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Teoneag%2FSimple-CLI-for-Java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Teoneag%2FSimple-CLI-for-Java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Teoneag%2FSimple-CLI-for-Java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Teoneag","download_url":"https://codeload.github.com/Teoneag/Simple-CLI-for-Java/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Teoneag%2FSimple-CLI-for-Java/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33957498,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-05T02:00:06.157Z","response_time":120,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["cli","interractive","java","simple"],"created_at":"2024-11-16T03:26:10.268Z","updated_at":"2026-06-05T19:31:33.929Z","avatar_url":"https://github.com/Teoneag.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003cpre\u003e\n███████╗██╗███╗   ███╗██████╗ ██╗     ███████╗     ██████╗██╗     ██╗\n██╔════╝██║████╗ ████║██╔══██╗██║     ██╔════╝    ██╔════╝██║     ██║\n███████╗██║██╔████╔██║██████╔╝██║     █████╗      ██║     ██║     ██║\n╚════██║██║██║╚██╔╝██║██╔═══╝ ██║     ██╔══╝      ██║     ██║     ██║\n███████║██║██║ ╚═╝ ██║██║     ███████╗███████╗    ╚██████╗███████╗██║\n╚══════╝╚═╝╚═╝     ╚═╝╚═╝     ╚══════╝╚══════╝     ╚═════╝╚══════╝╚═╝\n\u003c/pre\u003e\n\u003cdiv align=\"right\"\u003e\n\nA simple library for an interactive CLI.\n\nBy [Teodor Neagoe](https://github.com/Teoneag)\n\n\u003c/div\u003e\n\u003cimg src=\"gifs/Simple-CLI Preview.gif\" alt=\"Simple-CLI\"/\u003e\n\u003c/div\u003e\n\n## Getting Started\n\n### 0. Prerequisites\n\n- Os: Windows\n- Java: 22\n\n### 1. Clone the repository\n\n```bash\ngit clone https://github.com/Teoneag/Simple-CLI\n```\n\n### 2. Publish the library to your local maven repository\n\n```bash\n./gradlew publish\n```\n\n### Or alternatively you can run the example\n\nTo build it run\n```bash\n./gradlew build\n```\n\nAnd then to run it run\n```bash\njava -cp build/libs/Simple-CLI-1.0-SNAPSHOT.jar com.teoneag.Main\n```\n\nOr you can run it directly from gradle (but IO is a bit slower)\n\n```bash\n./gradlew run -q --console=plain\n```\n\nOr you can use IntelliJ IDEA to run it. (open the project and run the Main class)\n\n## Usage\n\nThis is an example of how to use the library:\n\n```java\nclass mainMenu {\n    // optional name - default: method name\n    // optional description - default: method name (args) -\u003e return type\n    @Command(name = \"hello\", description = \"Prints hello + \u003cname\u003e\")\n    public void hello(\n        @Param(name = \"name\", description = \"name to print\")\n        String name) {\n        System.out.println(\"Hello \" + name);\n    }\n\n    public static void main(String[] args) {\n        Shell shell = new Shell(mainMenu.class);\n        shell.start();\n    }\n}\n```\n\nYou just need to annotate the methods you want to be commands with `@Command`.\nThen those methods will be available in the shell.\n\n## Features\n\n- automatic help command generation (all functions annotated with @Command will be shown with name and description)\n- automatic parameter type checking (if the user inputs a wrong type the shell will tell them)\n\n## Plan -\u003e Actual: \n\nChronological order. Planned time -\u003e actual time\n- read similar projects (cliche) + write task + plan: 20m -\u003e 40m\n- make annotations: 5m -\u003e 5m\n- Write the Shell class: constructor + start method: 1h -\u003e 2h\n- check parameter types: 20 min -\u003e 40m\n- test it + write tests: 30m\n- document it: 15m\n- github description\n- add the nr of required arguments to invalid number of arguments: 5m -\u003e 4m\n- test it: 30m -\u003e 14m\n\n## ToDo\n\n- make exit not need a function\n- fix help order\n- fix \"Private method 'reset()' is never used\"\n- publish it: 30m -\u003e 12:00\n- make everything except command and shell private\n- fix deprecated gradle features\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteoneag%2Fsimple-cli-for-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteoneag%2Fsimple-cli-for-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteoneag%2Fsimple-cli-for-java/lists"}