{"id":33083940,"url":"https://github.com/devshawn/kafka-shell","last_synced_at":"2026-04-05T01:34:50.561Z","repository":{"id":62573622,"uuid":"176629189","full_name":"devshawn/kafka-shell","owner":"devshawn","description":"⚡A supercharged, interactive Kafka shell built on top of the existing Kafka CLI tools.","archived":false,"fork":false,"pushed_at":"2020-02-11T03:46:26.000Z","size":84,"stargazers_count":127,"open_issues_count":3,"forks_count":12,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-09-25T08:35:23.914Z","etag":null,"topics":["apache","cli","confluent","kafka","kafka-cli","kafka-tools","prompt","shell","stream-processing","streams","terminal"],"latest_commit_sha":null,"homepage":"","language":"Python","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/devshawn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-03-20T01:38:32.000Z","updated_at":"2025-08-09T18:27:41.000Z","dependencies_parsed_at":"2022-11-03T18:32:38.340Z","dependency_job_id":null,"html_url":"https://github.com/devshawn/kafka-shell","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/devshawn/kafka-shell","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devshawn%2Fkafka-shell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devshawn%2Fkafka-shell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devshawn%2Fkafka-shell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devshawn%2Fkafka-shell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devshawn","download_url":"https://codeload.github.com/devshawn/kafka-shell/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devshawn%2Fkafka-shell/sbom","scorecard":{"id":338343,"data":{"date":"2025-08-11","repo":{"name":"github.com/devshawn/kafka-shell","commit":"36158950ad3251956cfa9ace8451feee7f16338d"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.7,"checks":[{"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":"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":"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":"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":"Code-Review","score":0,"reason":"Found 0/18 approved changesets -- score normalized to 0","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":"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":"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":"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: Apache License 2.0: 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":"Vulnerabilities","score":7,"reason":"3 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2021-140 / GHSA-9w8r-397f-prfh","Warn: Project is vulnerable to: PYSEC-2023-117 / GHSA-mrwq-x4v8-fh7p","Warn: Project is vulnerable to: PYSEC-2021-141 / GHSA-pq64-v7f5-gqh8"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 14 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-18T05:14:21.618Z","repository_id":62573622,"created_at":"2025-08-18T05:14:21.618Z","updated_at":"2025-08-18T05:14:21.618Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31421869,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-05T00:25:07.052Z","status":"ssl_error","status_checked_at":"2026-04-05T00:25:05.923Z","response_time":60,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":["apache","cli","confluent","kafka","kafka-cli","kafka-tools","prompt","shell","stream-processing","streams","terminal"],"created_at":"2025-11-14T13:00:27.286Z","updated_at":"2026-04-05T01:34:50.553Z","avatar_url":"https://github.com/devshawn.png","language":"Python","funding_links":[],"categories":["CLI / Tools","CLI Tools"],"sub_categories":["Interactive Tools"],"readme":"# kafka-shell\n\n[![Build Status](https://travis-ci.org/devshawn/kafka-shell.svg?branch=master)](https://travis-ci.org/devshawn/kafka-shell) [![codecov](https://codecov.io/gh/devshawn/kafka-shell/branch/master/graph/badge.svg)](https://codecov.io/gh/devshawn/kafka-shell) ![PyPI](https://img.shields.io/pypi/v/kafka-shell.svg?color=blue) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/kafka-shell.svg) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)\n\nA supercharged, interactive Kafka shell built on top of the existing Kafka CLI tools.\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://i.imgur.com/b1oNTZZ.png\"/\u003e\n\u003c/p\u003e\n\nKafka shell allows you to configure a list of clusters, and properties such as `--bootstrap-server` and `--zookeeper` for the currently selected cluster will automatically be added when the command is run. No more remembering long server addresses or ports! \n\n## Installation\nKafka shell requires `python` and `pip`. Kafka shell is a wrapper over the existing Kafka command-line tools, so \nthose must exist within your `PATH`.\n\nYou can install kafka-shell using pip:\n\n```bash\npip install kafka-shell\n```\n\n## Usage\nKafka shell is an interactive shell. You can run it from the terminal by:\n\n```bash\nkafka-shell\n```\n\nFrom here, you can start typing `kafka` and the autocomplete will kick in.\n\n**Key Commands**\n- **Change Cluster**: The selected cluster commands are run against can be cycled through by pressing `F2`.\n- **Fuzzy Search**: By default, fuzzy search of commands is enabled. This can be toggled on \u0026 off by pressing `F3`.\n- **In-line Help**: By default, in-line help is shown along side the drop-down suggestion list. This can be toggled on \u0026 off by pressing `F9`.\n- **Exit**: The shell can be exited by pressing `F10` or by typing `exit`. \n\n## Configuration\nKafka shell allows you to configure settings and Kafka clusters to run commands against through a configuration file.\n\nBy default, when `kafka-shell` is first run, a directory in your home directory is generated at `~/.kafka-shell`. A configuration file called `config.yaml` is generated in that new folder. It is a YAML file containing details about clusters, `kafka-shell` configuration, and more.\n\nSee [CONFIGURATION.md][configuration] to add a cluster to your configuration or to set other `kafka-shell` settings.\n\n## Features\nKafka shell simplifies running complex Kafka CLI commands as well as provides smart auto-completion of commands, options, and more. /Users/shawn/.kafka-shell/config.yaml\n\n- Auto-completion of commands, options, and configurations\n- Configure clusters to run commands against and switch between them\n- Fish-style auto suggestions\n- Command history\n- Contextual help\n- Toolbar options\n\n**Completion of Configurations**\n\nAuto completion of Kafka configuration keys and their values.\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://i.imgur.com/fkwzOkv.png\"/\u003e\n\u003c/p\u003e\n\n**Configure Clusters, Schema Registries, \u0026 More**\n\nConfigure clusters and their properties will automatically be added to commands being run.\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://i.imgur.com/3JjIxyL.png\"/\u003e\n\u003c/p\u003e\n\n## Supported Commands\nCurrently, the following commands are supported:\n\n* `kafka-topics`\n* `kafka-configs`\n* `kafka-console-consumer`\n* `kafka-console-producer`\n* `kafka-avro-console-consumer`\n* `kafka-avro-console-producer`\n* `kafka-verifiable-consumer`\n* `kafka-verifiable-producer`\n* `kafka-preferred-replica-election`\n* `kafka-replica-verification`\n* `kafka-reassign-partitions`\n* `kafka-broker-api-versions`\n* `kafka-consumer-groups`\n* `kafka-delete-records`\n* `kafka-log-dirs`\n* `kafka-dump-log`\n* `kafka-acls`\n* `ksql`\n\n**Helper Commands**\n\nCurrently, kafka-shell has helper commands:\n\n* `exit`: exit the shell\n* `clear`: clear the shell\n* `cluster-select`: select a cluster\n* `cluster-describe`: describe a cluster config\n\nIn-line help for each command and option is shown by default. This can be toggled by `F9`.\n\n## Contributing\nContributions are very welcome. See [CONTRIBUTING.md][contributing] for details.\n\n## Acknowledgement\nThis project was inspired by multiple amazing shells \u0026 prompts, such as [saws][saws], [kube-shell][kube-shell], [kube-prompt][kube-prompt], [http-prompt][http-prompt], and [wharfee][wharfee]. It was built using [prompt-toolkit][prompt-toolkit]. Much ❤️ to [Apache Kafka][kafka] and [Confluent][confluent] for their helpful CLI tools. \n\n## License\nCopyright (c) 2019 Shawn Seymour.\n\nLicensed under the [Apache 2.0 license][license].\n\n[saws]: https://github.com/donnemartin/saws\n[kube-shell]: https://github.com/cloudnativelabs/kube-shell\n[kube-prompt]: https://github.com/c-bata/kube-prompt\n[http-prompt]: https://github.com/eliangcs/http-prompt\n[wharfee]: https://github.com/j-bennet/wharfee\n[prompt-toolkit]: https://github.com/prompt-toolkit/python-prompt-toolkit\n[kafka]: https://kafka.apache.org\n[confluent]: https://www.confluent.io/\n[configuration]: CONFIGURATION.md\n[contributing]: CONTRIBUTING.md\n[license]: LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevshawn%2Fkafka-shell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevshawn%2Fkafka-shell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevshawn%2Fkafka-shell/lists"}