{"id":18825407,"url":"https://github.com/grycap/vmrc-client","last_synced_at":"2026-01-21T00:30:16.053Z","repository":{"id":21939410,"uuid":"25263866","full_name":"grycap/vmrc-client","owner":"grycap","description":"VMRC's CLI","archived":false,"fork":false,"pushed_at":"2015-03-11T15:28:16.000Z","size":584,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-12-30T04:56:00.741Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/grycap.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}},"created_at":"2014-10-15T16:39:54.000Z","updated_at":"2015-06-26T07:47:43.000Z","dependencies_parsed_at":"2022-08-17T23:45:26.874Z","dependency_job_id":null,"html_url":"https://github.com/grycap/vmrc-client","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grycap%2Fvmrc-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grycap%2Fvmrc-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grycap%2Fvmrc-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grycap%2Fvmrc-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/grycap","download_url":"https://codeload.github.com/grycap/vmrc-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239763667,"owners_count":19692800,"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":[],"created_at":"2024-11-08T00:59:23.195Z","updated_at":"2026-01-21T00:30:16.003Z","avatar_url":"https://github.com/grycap.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"vmrc-client: A CLI \u0026 API for  VMRC\n===========\n\n\u003c!-- language: lang-none --\u003e\n    ____   ____  ____    ____  _______      ______  \n    |_  _| |_  _||_   \\  /   _||_   __ \\   .' ___  |\n     \\ \\   / /    |   \\/   |    | |__) | / .'   \\_|\n      \\ \\ / /     | |\\  /| |    |  __ /  | |\n       \\ ' /     _| |_\\/_| |_  _| |  \\ \\_\\ `.___.'\\\n        \\_/     |_____||_____||____| |___|`.____ .'\n\n\n A Virtual Machine Image Repository \u0026 Catalog\nDeveloped by the [Grid and High Performance Computing Group (GRyCAP)](http://www.grycap.upv.es) at the\n[Universitat Politècnica de València (UPV)](http://www.upv.es).\n\nWeb page: http://www.grycap.upv.es/vmrc\n\n0. Introduction\n=================\nVMRC is client-server system (based on Web Services) to index Virtual Machine Images (VMI)\nalong with its metadata (OS, applications, etc.). It supports matchmaking to obtain the appropriate VMIs\nthat satisfy a given set of hard (must) requirements and soft (should) requirements.\n\nCurrent version: 2.1.2\n\nThis repository only includes the VMRC client. Additional packages available are:\n  - [vmrc](http://github.com/grycap/vmrc) (The server-side part of the Repository \u0026 Catalog of VMIs)\n\nYou will require a running instance of the VMRC service to compile this code and to connect from this client.\nIf you are looking for a pre-compiled ready-to-use version of the VMRC client check the [webpage](http://www.grycap.upv.es/vmrc).\n\n1. Features\n============\n+ Java-based API to interact with [VMRC](https://www.github.com/grycap/vmrc)\n+ CLI (based on shell script) to interact with [VMRC](https://www.github.com/grycap/vmrc)\n\n\n2. Requirements\n===============\n+ Java JDK 1.7+\n+ Maven (to compile from sources)\n\n\n3. Compilation \u0026 Installation\n================================================\n1. Clone the repository from GitHub\n```\ngit clone https://github.com/grycap/vmrc-client.git\n```\n2. Make sure that the VMRC Server is up \u0026 running and listening at port 8080\n  * This is the default configuration if you followed the instructions when installing VMRC.\n  * During compilation of the client, the service WSDL is dynamically accessed to create some classes.\n3. Compile from sources with the command:\n```\n mvn package\n ```\nThe file $VMRC_CLIENT_LOCATION/target/vmrc-client.jar will be generated\n4. (Optional) Generate the documentation for the client-side Java API\n        mvn javadoc:javadoc\nThe documentation is generated in the target/site/apidocs folder.\n\nThe CLI tools are available in the tools folder\n  * vmrc.sh: To register, query, list, deregister and change permissions of VMIs.\n  * vmrc-admin.sh: To create, delete, list or update users, etc.\n\n4. Usage\n===========\n1. You should use vmrc.sh and vmrc-admin.sh as the CLI tools for user and admin commands respectively.\n2. There are sample VMI descriptors in the [src/test/vmis] directory\n3. The API documentation is available in the [target/site/apidocs] folder.\n   In particular, the org.grycap.vmrc.client.api.VMRCServerAPI provides a Java API to contact VMRC.\n\nYou have further information in the VMRC client manual available both in the [webpage](http://www.grycap.upv.es/vmrc) and in the [manual] folder at the repo. \n5. Additional Configuration\n===========================\n1. Create the file $HOME/.vmrc/vmrc_auth with user:password. This information is employed to contact the VMRC server.\n2. Create the file $HOME/.vmrc/vmrc.properties with the following properties:\n       vmrc.uri = http://machine:8080/vmrc/vmrc\n  Customize it according to your deployment: machine/port/https.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrycap%2Fvmrc-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrycap%2Fvmrc-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrycap%2Fvmrc-client/lists"}