{"id":37647782,"url":"https://github.com/bendemott/solr-zkutil","last_synced_at":"2026-01-16T11:27:47.508Z","repository":{"id":57469279,"uuid":"81284458","full_name":"bendemott/solr-zkutil","owner":"bendemott","description":"Solr Cloud and ZooKeeper CLI ","archived":false,"fork":false,"pushed_at":"2018-06-01T19:01:50.000Z","size":115,"stargazers_count":15,"open_issues_count":18,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-12-07T09:32:13.661Z","etag":null,"topics":["cli","solr","solrcloud","zookeeper"],"latest_commit_sha":null,"homepage":"","language":"Python","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/bendemott.png","metadata":{"files":{"readme":"README.rst","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":"2017-02-08T03:42:54.000Z","updated_at":"2022-12-13T03:55:48.000Z","dependencies_parsed_at":"2022-09-19T10:10:30.410Z","dependency_job_id":null,"html_url":"https://github.com/bendemott/solr-zkutil","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/bendemott/solr-zkutil","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bendemott%2Fsolr-zkutil","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bendemott%2Fsolr-zkutil/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bendemott%2Fsolr-zkutil/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bendemott%2Fsolr-zkutil/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bendemott","download_url":"https://codeload.github.com/bendemott/solr-zkutil/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bendemott%2Fsolr-zkutil/sbom","scorecard":{"id":231786,"data":{"date":"2025-08-11","repo":{"name":"github.com/bendemott/solr-zkutil","commit":"abf379ade4db7a1fa65c85a279b40534a16f375f"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.6,"checks":[{"name":"Code-Review","score":4,"reason":"Found 4/9 approved changesets -- score normalized to 4","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 26 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-17T04:58:46.596Z","repository_id":57469279,"created_at":"2025-08-17T04:58:46.597Z","updated_at":"2025-08-17T04:58:46.597Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28478258,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T06:30:42.265Z","status":"ssl_error","status_checked_at":"2026-01-16T06:30:16.248Z","response_time":107,"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":["cli","solr","solrcloud","zookeeper"],"created_at":"2026-01-16T11:27:46.836Z","updated_at":"2026-01-16T11:27:47.500Z","avatar_url":"https://github.com/bendemott.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"=======================\r\nsolr-zkutil CLI Utility \r\n=======================\r\n\r\nAbout\r\n-----\r\n``solr-zkutil`` is an easy to use tool written in ``Python`` that allows you to quickly understand\r\ninformation about your **Solr** ZooKeeper cluster.\r\n\r\nIf you live in an ethereal environment in which solr-hosts are frequently changing, or you have\r\nmany different solr environments to keep track of, this tool is for you!\r\n\r\nThe program is designed to work with **Windows** or **Linux** hosts, and is easy to install.\r\n\r\nRuns on **python3** or **python2**!\r\n\r\nFeatures\r\n--------\r\n|livenodesgif|\r\n\r\nSupports environment aliases for ZooKeeper Connections\r\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ \r\n|environmentconf|\r\n\r\nAdd your ZooKeeper connection string to the program and an environment alias\r\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r\n::\r\n\r\n    solr-zkutil config --add 'DEV=zk01.host.com:2181,zk02.host.com:2181,zk03.host.com:2181'\r\n    \r\n| `Or replace the configuration entirely using valid json`\r\n\r\n::\r\n    \r\n    solr-zkutil config --configuration '{\\\"DEV\\\":\\\"zk01.dev.host.com:2181,zk02.dev.host.com:2181,zk03.dev.host.com:2181\\\", \\\"QA\\\": \\\"zk01.qa.host.com:2181,zk02.qa.host.com:2181,zk03.qa.host.com:2181\\\"}'\r\n\r\n\r\n|environmentadd|\r\n\r\nQuery ZooKeeper for Solr Hosts, and Open the administration web-interface automatically\r\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r\n| ``solr-zkutil live-nodes --env DEV --browser``\r\n\r\n| `or`\r\n\r\n| ``solr-zkutil live-nodes -z zk01.dev.host.com:2181 --browser``\r\n\r\n|livenodes|\r\n\r\nWatch any ZooKeeper file/node for changes, during deployments, etc\r\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r\n| ``solr-zkutil watch /live_nodes --env DEV``\r\n\r\n| `or`\r\n\r\n| ``solr-zkutil watch /clusterstate.json --env PROD`` \r\n\r\n|watchnode|\r\n\r\nIssue Administrative Commands Easily\r\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r\n| ``solr-zkutil admin RUOK --env DEV``\r\n\r\n|admincmd|\r\n\r\n| ``solr-zkutil ls /live_nodes -z zk01.dev.host.com:2181,zk02.dev.host.com:2181,zk03.dev.host.com:2181``\r\n\r\n| `or.. note that ls can also be used to view the contents of node`\r\n\r\n| ``solr-zkutil ls /clusterstate.json --env PROD --all-hosts``\r\n\r\nView the contents/children of a node across all ensemble (cluster) members quickly\r\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r\n|lsnodesall|\r\n\r\nView all nodes, with stats info\r\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r\n|lsnodesdebug|\r\n\r\nExecute admin commands across all nodes\r\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r\n|adminall|\r\n\r\nInstallation\r\n------------\r\n\r\nWindows\r\n^^^^^^^\r\nOn windows install ``Python 2.7`` or ``Python 3.3+``, and ensure Python ``exe`` and ``Scripts`` paths are configured \r\nto be on your Windows Path environment, and the program should be accessible through ``PowerShell``\r\nor ``cmd.exe``.  \r\n\r\nSetting up Python Paths is an option during the installation of the Python Package on Windows, I highly suggest you check the box, or mark the feature **add Python to system path** so this step is accomplished for you.\r\n\r\n`Note: I will try to add a bundled exe installer soon for Windows`\r\n\r\n**Python Include Paths**\r\n\r\n- ``C:\\Python27``\r\n- ``C:\\Python27\\Scripts``\r\n\r\nThe ``pip`` command is bundled with the Python Windows installation.\r\n\r\nOnce you have this configured you should be able to also execute ``pip`` without specifying its path.\r\n\r\nLinux\r\n^^^^^\r\nA recent version of Python ships with most linux distributions, if you don't have pip\r\ninstall it with (ubuntu/debian)::\r\n\r\n    sudo apt-get install python-pip\r\n    \r\n(Fedora)::\r\n\r\n    sudo dnf install python-pip\r\n    \r\nThere are no additional special instructions on Linux.\r\n\r\nInstalling from PyPi (recommended)\r\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r\n::\r\n\r\n    pip install solr-zkutil\r\n    \r\nOr to update your solr-zkutil to the latest version::\r\n\r\n    pip install solr-zkutil --upgrade\r\n\r\nInstall Manually\r\n^^^^^^^^^^^^^^^^\r\nSimply download, clone the repository, open a console and execute:\r\n``python setup.py install`` \r\n\r\nOn windows if you have not configured your Python environment you can install with::\r\n\r\n    C:\\Python27\\python.exe setup.py install\r\n\r\nInstall from pip/github\r\n^^^^^^^^^^^^^^^^^^^^^^^\r\n::\r\n\r\n    pip install git+https://github.com/bendemott/solr-zkutil.git\r\n\r\n\r\nProgram Commands\r\n----------------\r\nOnce installed the program is executable using the command::\r\n\r\n    solr-zkutil\r\n\r\nFor help with the command type::\r\n\r\n    solr-zkutil --help\r\n\r\nIf you are having trouble configuring paths the program can also be ran using:: \r\n\r\n    python -m solrzkutil\r\n\r\nor for `Windows`:: \r\n\r\n    C:\\Python27\\python.exe -m solrzkutil \r\n\r\nUsage\r\n^^^^^\r\n::\r\n\r\n    usage: solr-zkutil [-h]\r\n                       {live-nodes,clusterstate,watch,ls,stat,admin,config} ...\r\n\r\n    positional arguments:\r\n      {live-nodes,clusterstate,watch,ls,stat,admin,config}\r\n                            --- available sub-commands ---\r\n        live-nodes          List Solr Live Nodes from ZooKeeper\r\n        clusterstate        List Solr Collections and Nodes\r\n        watch               Watch a ZooKeeper Node for Changes\r\n        ls                  List a ZooKeeper Node\r\n        stat                Check ZooKeeper ensemble status\r\n        admin               Execute a ZooKeeper administrative command\r\n        config              Show connection strings, or set environment\r\n                            configuration\r\n\r\n    optional arguments:\r\n      -h, --help            show this help message and exit\r\n      \r\n      \r\n.. |livenodesgif| image:: http://i.imgur.com/uTROF7Z.gif\r\n.. |environmentconf| image:: http://i.imgur.com/v1df7K9.png\r\n.. |environmentadd| image:: http://i.imgur.com/UL1peUD.png\r\n.. |livenodes| image:: http://i.imgur.com/QpQt1Xs.png\r\n.. |watchnode| image:: http://i.imgur.com/9S9x9wb.png\r\n.. |admincmd| image:: http://i.imgur.com/Wm1DpmL.png\r\n.. |lsnodesall| image:: http://i.imgur.com/Lk1yVtB.png\r\n.. |lsnodesdebug| image:: http://i.imgur.com/mcl54I5.png\r\n.. |adminall| image:: http://i.imgur.com/aDqCdzE.png\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbendemott%2Fsolr-zkutil","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbendemott%2Fsolr-zkutil","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbendemott%2Fsolr-zkutil/lists"}