{"id":19489075,"url":"https://github.com/vladimirvivien/jmx-cli","last_synced_at":"2025-04-25T18:32:58.462Z","repository":{"id":2620852,"uuid":"3605408","full_name":"vladimirvivien/jmx-cli","owner":"vladimirvivien","description":"[Project Inactive] Jmx-Cli is a command-line interface console for JMX","archived":true,"fork":false,"pushed_at":"2012-09-14T19:45:23.000Z","size":222,"stargazers_count":65,"open_issues_count":3,"forks_count":19,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-04T02:11:34.772Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vladimirvivien.png","metadata":{"files":{"readme":"README","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-03-02T19:36:03.000Z","updated_at":"2025-03-26T13:19:33.000Z","dependencies_parsed_at":"2022-07-12T14:58:16.510Z","dependency_job_id":null,"html_url":"https://github.com/vladimirvivien/jmx-cli","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vladimirvivien%2Fjmx-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vladimirvivien%2Fjmx-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vladimirvivien%2Fjmx-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vladimirvivien%2Fjmx-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vladimirvivien","download_url":"https://codeload.github.com/vladimirvivien/jmx-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250872425,"owners_count":21500821,"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":["java","jmx","mbean"],"created_at":"2024-11-10T21:07:14.970Z","updated_at":"2025-04-25T18:32:58.213Z","avatar_url":"https://github.com/vladimirvivien.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"Jmx-Cli\n-------\nJmx-Cli is a command-line interface console for JMX.  It is developed using the Clamshell-Cli framework (http://code.google.com/p/clamshell-cli/).\n\nInstallation\n------------\n1. Download the current distribution from https://github.com/vladimirvivien/jmx-cli/downloads.\n2. Unzip at the location of your choosing (jmx-cli-home).\n3. Cd to jmx-cli-home\n4. From the command prompt, type \n   \u003e java -jar cli.jar\n\nIf all works ok, you should see:\n\n    /#####                                /######    /##   /##\n   |__  ##                               /##__  ##  | ##  |__/\n      | ##   /######/####    /##   /##  | ##  \\__/  | ##   /##\n      | ##  | ##_  ##_  ##  |  ## /##/  | ##        | ##  | ##\n /##  | ##  | ## \\ ## \\ ##   \\  ####/   | ##        | ##  | ##\n| ##  | ##  | ## | ## | ##    \u003e##  ##   | ##    ##  | ##  | ##\n|  ######/  | ## | ## | ##   /##/\\  ##  |  ######/  | ##  | ##\n \\______/   |__/ |__/ |__/  |__/  \\__/   \\______/   |__/  |__/\n\nA command-line tool for JMX\nPowered by Clamshell-Cli framework \nhttp://code.google.com/p/clamshell-cli/\n\nGetting Started\n---------------\nUsing Jmx-Cli is straight forward.  From the prompt type 'help' to get a list of available commands:\n\n      exit       Exits ClamShell.\n      help       Displays help information for available commands.\n        ps       Displays a list of running JVM processes (similar to jps tool)\n   connect       Connects to local or remote JVM MBean server.\n     mbean       Creates a label for identifying an MBean\n      desc       Prints description for specified mbean.\n      list       Lists JMX MBeans.\n      exec       Execute MBean operations and getter/setter attributes.\n\nCommand Hints\n-------------\nYou can also get command hints from the prompt by pressing on the tab key.  This will list all available combinations of input.  You can narrow down the hints by typing a few letters of the command then press tab.\n\nConnecting to JVM\n-----------------\nTo connect to a running local JVM, do the followings:\n1. Use the 'ps' command to get a list of JMV processes running locally:\n\t\u003e ps\n\t1444\tcli.jar\n\t1740\torg.apache.catalina.startup.Bootstrap\n\t\n2. use the 'connect' command to attach to a running process\n\t\u003e connect pid:1740\n\nThe sequence above connects to a running instance of Tomcat server.\n\t\nListing MBeans\n--------------\nOnce connected to a JVM, you can query available MBeans that are running in that JVM.  Use the 'list' command to retrieve lists of MBeans.\n\n\u003e list filter:\"Catalina:*\"\n\nThe command above will list all MBeans running in the \"Catalina\" domain.  You can label the list for future reference by typing:\n\n\u003e list filter:\"Catalina:*\" label:true\n\nMBean list [Catalina:*]\n     [$0] Catalina:type=Server\n     [$1] Catalina:realmPath=/realm0/realm0,type=Realm\n...\n\nDescribing an MBean\n-------------------\nOnce you have a list, you can select a bean to describe.  The following describes bean with label 'Catalina:port=8080,type=Connector':\n\n\u003e desc bean:\"Catalina:port=8080,type=Connector\"\n\nMBean: Catalina:port=8080,type=Connector (org.apache.catalina.mbeans.ConnectorMBean)\nImplementation of a Coyote connector\n\nAttributes:\n     port : int (rw) - The port number on which we listen for requests\n     useIPVHosts : boolean (rw) - Should IP-based virtual hosting be used? \n     redirectPort : int (rw) - The redirect port for non-SSL to SSL redirects\n     minSpareThreads : int (rw) - The number of request processing threads that will be created\n     secure : boolean (rw) - Is this a secure (SSL) Connector?\n     acceptCount : int (rw) - The accept count for this Connector\n     maxThreads : int (rw) - The maximum number of request processing threads to be created\n     URIEncoding : java.lang.String (rw) - Character encoding used to decode the URI\n     modelerType : java.lang.String (r) - Type of the modeled resource. Can be set only once\n     packetSize : int (rw) - The ajp packet size.\n     processorCache : int (rw) - The processor cache size.\n...\n     xpoweredBy : boolean (rw) - Is generation of X-Powered-By response header enabled/disabled?\n     stateName : java.lang.String (r) - The name of the LifecycleState that this component is currently in\n     allowTrace : boolean (rw) - Allow disabling TRACE method\n     useBodyEncodingForURI : boolean (rw) - Should the body encoding be used for URI query parameters\n     secret : java.lang.String (w) - Authentication secret (I guess ... not in Javadocs)\n\nOperations:\n     destroy():void\n     pause():void\n     stop():void\n     resume():void\n     start():void\n     init():void\n     \nThe same command can be issued using the associated label of the bean from the list (see above):\n\u003e desc bean:$28\n\nExecute an Operation\n--------------------\nJmx-cli lets you execute operation on your management beans as well.  The next examples shuts down the Tomcat connector for port 8080:\n\n\u003e exec bean:\"Catalina:port=8080,type=Connector\" op:\"stop\"\n\n\nKnown Issues\n------------\n1. 64-bit Windows not compatible with current jline library.\n2. Some of the commands do not work in Jdk7 (i.e. ps command.)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvladimirvivien%2Fjmx-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvladimirvivien%2Fjmx-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvladimirvivien%2Fjmx-cli/lists"}