Overview Version History Q & A Rating & Review
🧱 Quick-Kafka Extension for VS Code
Quick-Kafka is a Visual Studio Code extension that helps you quickly spin up Kafka containers, configure your environment, and launch an interactive Kafka shell using Python.
🚀 Features
🔧 Quick Setup Wizard via Command Palette
🧙 Advanced Setup Wizard with multi-step configuration
🌐 Webview-based UI for advanced settings
🐳 Docker Compose Integration to start Kafka containers
🐍 Kafka Shell Launcher using Python or IPython
⚙️ Persistent Settings saved across sessions
🛠️ Health Checks for Kafka readiness
🔁 Auto Start/Shutdown Docker (configurable)
📁 File Structure
quick-kafka-extension/
├── package.json
├── src/
│ ├── extension.ts
│ └── setup/
│ ├── advancedSetup.ts
│
├── media/
│ └── webview.html
├── assets/
├── docker-compose.yaml
└── kafka_shell.py
⚙️ Configuration Settings
Setting
Description
quickKafka.pythonPath
Path to Python interpreter
quickKafka.composePath
Path to Docker Compose file
quickKafka.shellPath
Path to Kafka shell script
quickKafka.shellType
ipython
or python
quickKafka.debugLogging
Enable debug logs
quickKafka.shutdownOnExit
Shutdown Docker when terminal closes
quickKafka.autoStartDocker
Try to auto-start Docker if not running
quickKafka.brokerContainerName
Kafka container name
quickKafka.healthCheckTimeout
Timeout for Kafka health check (ms)
🧪 Commands
Quick-Kafka: Quick Setup
Quick-Kafka: Advanced Setup
Quick-Kafka: Start Kafka Environment
🛠️ Development & Publishing
1. Install Prerequisites
Node.js
VSCE (Visual Studio Code Extension Manager)
npm install -g vsce