heroku-kafka

{ "commands": { "kafka:credentials": { "aliases": [], "args": { "cluster": { "description": "cluster to operate on", "name": "cluster", "required": false } }, "description": "triggers credential rotation", "examples": [ "$ heroku kafka:credentials --reset", "$ heroku kafka:credentials KAFKA_RED_URL --reset" ], "flags": { "prompt": { "description": "interactively prompt for command arguments and flags", "helpGroup": "GLOBAL", "name": "prompt", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": true, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "reset": { "description": "reset credentials", "name": "reset", "required": true, "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "kafka:credentials", "pluginAlias": "heroku-kafka", "pluginName": "heroku-kafka", "pluginType": "core", "strict": true, "enableJsonFlag": false, "promptFlagActive": true, "topic": "kafka", "isESM": true, "relativePath": [ "dist", "commands", "kafka", "credentials.js" ] }, "kafka:fail": { "aliases": [], "args": { "cluster": { "description": "cluster to operate on", "name": "cluster", "required": false } }, "description": "triggers failure on one node in the cluster", "examples": [ "$ heroku kafka:fail", "$ heroku kafka:fail kafka-aerodynamic-32763" ], "flags": { "prompt": { "description": "interactively prompt for command arguments and flags", "helpGroup": "GLOBAL", "name": "prompt", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": true, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "catastrophic": { "description": "terminate the underlying instance instead and allow automation to replace it", "name": "catastrophic", "allowNo": false, "type": "boolean" }, "zookeeper": { "description": "induce failure on one of the cluster's Zookeeper nodes instead", "name": "zookeeper", "allowNo": false, "type": "boolean" }, "confirm": { "description": "pass the app name to skip the manual confirmation prompt", "name": "confirm", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "kafka:fail", "pluginAlias": "heroku-kafka", "pluginName": "heroku-kafka", "pluginType": "core", "strict": true, "enableJsonFlag": false, "promptFlagActive": true, "topic": "kafka", "isESM": true, "relativePath": [ "dist", "commands", "kafka", "fail.js" ] }, "kafka:info": { "aliases": [ "kafka" ], "args": { "cluster": { "description": "cluster to operate on", "name": "cluster", "required": false } }, "description": "display cluster information", "examples": [ "$ heroku kafka", "$ heroku kafka:info", "$ heroku kafka:info HEROKU_KAFKA_BROWN_URL" ], "flags": { "prompt": { "description": "interactively prompt for command arguments and flags", "helpGroup": "GLOBAL", "name": "prompt", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": true, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "kafka:info", "pluginAlias": "heroku-kafka", "pluginName": "heroku-kafka", "pluginType": "core", "strict": true, "enableJsonFlag": false, "promptFlagActive": true, "topic": "kafka", "isESM": true, "relativePath": [ "dist", "commands", "kafka", "info.js" ] }, "kafka:upgrade": { "aliases": [], "args": { "cluster": { "description": "cluster to operate on", "name": "cluster", "required": false } }, "description": "upgrades kafka broker version", "examples": [ "$ heroku kafka:upgrade --version 0.9" ], "flags": { "prompt": { "description": "interactively prompt for command arguments and flags", "helpGroup": "GLOBAL", "name": "prompt", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": true, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version": { "description": "requested kafka version for upgrade", "name": "version", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "confirm": { "description": "pass the app name to skip the manual confirmation prompt", "name": "confirm", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "kafka:upgrade", "pluginAlias": "heroku-kafka", "pluginName": "heroku-kafka", "pluginType": "core", "strict": true, "enableJsonFlag": false, "promptFlagActive": true, "topic": "kafka", "isESM": true, "relativePath": [ "dist", "commands", "kafka", "upgrade.js" ] }, "kafka:wait": { "aliases": [], "args": { "cluster": { "description": "cluster to operate on", "name": "cluster", "required": false } }, "description": "waits until Kafka is ready to use", "examples": [ "$ heroku kafka:wait", "$ heroku kafka:wait HEROKU_KAFKA_BROWN" ], "flags": { "prompt": { "description": "interactively prompt for command arguments and flags", "helpGroup": "GLOBAL", "name": "prompt", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": true, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait-interval": { "description": "how frequently to poll in seconds (to avoid rate limiting)", "name": "wait-interval", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "kafka:wait", "pluginAlias": "heroku-kafka", "pluginName": "heroku-kafka", "pluginType": "core", "strict": true, "enableJsonFlag": false, "promptFlagActive": true, "topic": "kafka", "isESM": true, "relativePath": [ "dist", "commands", "kafka", "wait.js" ] }, "kafka:zookeeper": { "aliases": [], "args": { "value": { "description": "on/off, enable/disable", "name": "value", "required": true }, "cluster": { "description": "cluster to operate on", "name": "cluster", "required": false } }, "description": "(Private Spaces only) control direct access to Zookeeper of your Kafka cluster", "examples": [ "$ heroku kafka:zookeeper enable", "$ heroku kafka:zookeeper disable HEROKU_KAFKA_BROWN_URL" ], "flags": { "prompt": { "description": "interactively prompt for command arguments and flags", "helpGroup": "GLOBAL", "name": "prompt", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": true, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "kafka:zookeeper", "pluginAlias": "heroku-kafka", "pluginName": "heroku-kafka", "pluginType": "core", "strict": true, "enableJsonFlag": false, "promptFlagActive": true, "topic": "kafka", "isESM": true, "relativePath": [ "dist", "commands", "kafka", "zookeeper.js" ] }, "kafka:consumer-groups:create": { "aliases": [], "args": { "consumer_group": { "description": "consumer group name", "name": "consumer_group", "required": true }, "cluster": { "description": "cluster to operate on", "name": "cluster", "required": false } }, "description": "creates a consumer group in Kafka", "examples": [ "$ heroku kafka:consumer-groups:create word-counters", "$ heroku kafka:consumer-groups:create word-counters kafka-aerodynamic-32763" ], "flags": { "prompt": { "description": "interactively prompt for command arguments and flags", "helpGroup": "GLOBAL", "name": "prompt", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": true, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "kafka:consumer-groups:create", "pluginAlias": "heroku-kafka", "pluginName": "heroku-kafka", "pluginType": "core", "strict": true, "enableJsonFlag": false, "promptFlagActive": true, "topic": "kafka", "isESM": true, "relativePath": [ "dist", "commands", "kafka", "consumer-groups", "create.js" ] }, "kafka:consumer-groups:destroy": { "aliases": [], "args": { "consumer_group": { "description": "consumer group name", "name": "consumer_group", "required": true }, "cluster": { "description": "cluster to operate on", "name": "cluster", "required": false } }, "description": "destroys a consumer group in Kafka", "examples": [ "$ heroku kafka:consumer-groups:destroy word-counters", "$ heroku kafka:consumer-groups:destroy word-counters kafka-aerodynamic-32763" ], "flags": { "prompt": { "description": "interactively prompt for command arguments and flags", "helpGroup": "GLOBAL", "name": "prompt", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": true, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "confirm": { "description": "pass the app name to skip the manual confirmation prompt", "name": "confirm", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "kafka:consumer-groups:destroy", "pluginAlias": "heroku-kafka", "pluginName": "heroku-kafka", "pluginType": "core", "strict": true, "enableJsonFlag": false, "promptFlagActive": true, "topic": "kafka", "isESM": true, "relativePath": [ "dist", "commands", "kafka", "consumer-groups", "destroy.js" ] }, "kafka:consumer-groups": { "aliases": [], "args": { "cluster": { "description": "cluster to operate on", "name": "cluster", "required": false } }, "description": "lists available Kafka consumer groups", "examples": [ "$ heroku kafka:consumer-groups", "$ heroku kafka:consumer-groups kafka-aerodynamic-32763" ], "flags": { "prompt": { "description": "interactively prompt for command arguments and flags", "helpGroup": "GLOBAL", "name": "prompt", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": true, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "kafka:consumer-groups", "pluginAlias": "heroku-kafka", "pluginName": "heroku-kafka", "pluginType": "core", "strict": true, "enableJsonFlag": false, "promptFlagActive": true, "topic": "kafka", "isESM": true, "relativePath": [ "dist", "commands", "kafka", "consumer-groups", "index.js" ] }, "kafka:topics:compaction": { "aliases": [], "args": { "topic": { "description": "topic name", "name": "topic", "required": true }, "value": { "description": "enable or disable", "name": "value", "required": true }, "cluster": { "description": "cluster to operate on", "name": "cluster", "required": false } }, "description": "configures topic compaction in Kafka", "examples": [ "$ heroku kafka:topics:compaction page-visits enable", "$ heroku kafka:topics:compaction page-visits disable kafka-shiny-2345" ], "flags": { "prompt": { "description": "interactively prompt for command arguments and flags", "helpGroup": "GLOBAL", "name": "prompt", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": true, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "kafka:topics:compaction", "pluginAlias": "heroku-kafka", "pluginName": "heroku-kafka", "pluginType": "core", "strict": true, "enableJsonFlag": false, "promptFlagActive": true, "topic": "kafka", "isESM": true, "relativePath": [ "dist", "commands", "kafka", "topics", "compaction.js" ] }, "kafka:topics:create": { "aliases": [], "args": { "topic": { "description": "topic name", "name": "topic", "required": true }, "cluster": { "description": "cluster to operate on", "name": "cluster", "required": false } }, "description": "creates a topic in Kafka", "examples": [ "$ heroku kafka:topics:create page-visits --partitions 100", "$ heroku kafka:topics:create page-visits kafka-shiny-2345 --partitions 100 --replication-factor 3 --retention-time 10d", "$ heroku kafka:topics:create page-visits kafka-shiny-2345 --partitions 100 --compaction" ], "flags": { "prompt": { "description": "interactively prompt for command arguments and flags", "helpGroup": "GLOBAL", "name": "prompt", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": true, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "partitions": { "description": "number of partitions to give the topic", "name": "partitions", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "replication-factor": { "description": "number of replicas the topic should be created across", "name": "replication-factor", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "retention-time": { "description": "length of time messages in the topic should be retained (at least 24h)", "name": "retention-time", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "compaction": { "description": "whether to use compaction for this topic", "name": "compaction", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "kafka:topics:create", "pluginAlias": "heroku-kafka", "pluginName": "heroku-kafka", "pluginType": "core", "strict": true, "enableJsonFlag": false, "promptFlagActive": true, "topic": "kafka", "isESM": true, "relativePath": [ "dist", "commands", "kafka", "topics", "create.js" ] }, "kafka:topics:destroy": { "aliases": [], "args": { "topic": { "description": "topic name", "name": "topic", "required": true }, "cluster": { "description": "cluster to operate on", "name": "cluster", "required": false } }, "description": "deletes a topic in Kafka", "examples": [ "$ heroku kafka:topics:destroy page-visits", "$ heroku kafka:topics:destroy page-visits HEROKU_KAFKA_BROWN_URL" ], "flags": { "prompt": { "description": "interactively prompt for command arguments and flags", "helpGroup": "GLOBAL", "name": "prompt", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": true, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "confirm": { "description": "pass the app name to skip the manual confirmation prompt", "name": "confirm", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "kafka:topics:destroy", "pluginAlias": "heroku-kafka", "pluginName": "heroku-kafka", "pluginType": "core", "strict": true, "enableJsonFlag": false, "promptFlagActive": true, "topic": "kafka", "isESM": true, "relativePath": [ "dist", "commands", "kafka", "topics", "destroy.js" ] }, "kafka:topics": { "aliases": [], "args": { "cluster": { "description": "cluster to operate on", "name": "cluster", "required": false } }, "description": "lists available Kafka topics", "examples": [ "$ heroku kafka:topics", "$ heroku kafka:topics HEROKU_KAFKA_BROWN_URL" ], "flags": { "prompt": { "description": "interactively prompt for command arguments and flags", "helpGroup": "GLOBAL", "name": "prompt", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": true, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "kafka:topics", "pluginAlias": "heroku-kafka", "pluginName": "heroku-kafka", "pluginType": "core", "strict": true, "enableJsonFlag": false, "promptFlagActive": true, "topic": "kafka", "isESM": true, "relativePath": [ "dist", "commands", "kafka", "topics", "index.js" ] }, "kafka:topics:info": { "aliases": [], "args": { "topic": { "description": "topic name", "name": "topic", "required": true }, "cluster": { "description": "cluster to operate on", "name": "cluster", "required": false } }, "description": "shows information about a topic in Kafka", "examples": [ "$ heroku kafka:topics:info page-visits", "$ heroku kafka:topics:info page-visits HEROKU_KAFKA_BROWN_URL" ], "flags": { "prompt": { "description": "interactively prompt for command arguments and flags", "helpGroup": "GLOBAL", "name": "prompt", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": true, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "kafka:topics:info", "pluginAlias": "heroku-kafka", "pluginName": "heroku-kafka", "pluginType": "core", "strict": true, "enableJsonFlag": false, "promptFlagActive": true, "topic": "kafka", "isESM": true, "relativePath": [ "dist", "commands", "kafka", "topics", "info.js" ] }, "kafka:topics:replication-factor": { "aliases": [], "args": { "topic": { "description": "topic name", "name": "topic", "required": true }, "value": { "description": "replication factor", "name": "value", "required": true }, "cluster": { "description": "cluster to operate on", "name": "cluster", "required": false } }, "description": "configures topic replication factor in Kafka", "examples": [ "$ heroku kafka:topics:replication-factor page-visits 3", "$ heroku kafka:topics:replication-factor page-visits 3 HEROKU_KAFKA_BROWN_URL" ], "flags": { "prompt": { "description": "interactively prompt for command arguments and flags", "helpGroup": "GLOBAL", "name": "prompt", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": true, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "kafka:topics:replication-factor", "pluginAlias": "heroku-kafka", "pluginName": "heroku-kafka", "pluginType": "core", "strict": true, "enableJsonFlag": false, "promptFlagActive": true, "topic": "kafka", "isESM": true, "relativePath": [ "dist", "commands", "kafka", "topics", "replication-factor.js" ] }, "kafka:topics:retention-time": { "aliases": [], "args": { "topic": { "description": "topic name", "name": "topic", "required": true }, "value": { "description": "retention time (e.g. 10d, 36h) or disable", "name": "value", "required": true }, "cluster": { "description": "cluster to operate on", "name": "cluster", "required": false } }, "description": "configures or disables topic retention time (e.g. 10d, 36h)", "examples": [ "$ heroku kafka:topics:retention-time page-visits 10d", "$ heroku kafka:topics:retention-time page-visits disable", "$ heroku kafka:topics:retention-time page-visits 36h kafka-shiny-2345" ], "flags": { "prompt": { "description": "interactively prompt for command arguments and flags", "helpGroup": "GLOBAL", "name": "prompt", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": true, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "kafka:topics:retention-time", "pluginAlias": "heroku-kafka", "pluginName": "heroku-kafka", "pluginType": "core", "strict": true, "enableJsonFlag": false, "promptFlagActive": true, "topic": "kafka", "isESM": true, "relativePath": [ "dist", "commands", "kafka", "topics", "retention-time.js" ] }, "kafka:topics:tail": { "aliases": [], "args": { "topic": { "description": "topic name", "name": "topic", "required": true }, "cluster": { "description": "cluster to operate on", "name": "cluster", "required": false } }, "description": "tails a topic in Kafka", "examples": [ "$ heroku kafka:topics:tail page-visits", "$ heroku kafka:topics:tail page-visits kafka-aerodynamic-32763", "$ heroku kafka:topics:tail page-visits --max-length 200" ], "flags": { "prompt": { "description": "interactively prompt for command arguments and flags", "helpGroup": "GLOBAL", "name": "prompt", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": true, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "max-length": { "description": "number of characters per message to output", "name": "max-length", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "kafka:topics:tail", "pluginAlias": "heroku-kafka", "pluginName": "heroku-kafka", "pluginType": "core", "strict": true, "enableJsonFlag": false, "promptFlagActive": true, "topic": "kafka", "isESM": true, "relativePath": [ "dist", "commands", "kafka", "topics", "tail.js" ] }, "kafka:topics:write": { "aliases": [], "args": { "topic": { "description": "topic name", "name": "topic", "required": true }, "message": { "description": "message to write", "name": "message", "required": true }, "cluster": { "description": "cluster to operate on", "name": "cluster", "required": false } }, "description": "writes a message to a Kafka topic", "examples": [ "$ heroku kafka:topics:write page_visits \"1441025138,www.example.com,192.168.2.13\"", "$ heroku kafka:topics:write page_visits \"1441025138,www.example.com,192.168.2.13\" kafka-aerodynamic-32763" ], "flags": { "prompt": { "description": "interactively prompt for command arguments and flags", "helpGroup": "GLOBAL", "name": "prompt", "allowNo": false, "type": "boolean" }, "app": { "char": "a", "description": "app to run command against", "name": "app", "required": true, "hasDynamicHelp": true, "multiple": false, "type": "option" }, "remote": { "char": "r", "description": "git remote of app to use", "name": "remote", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "key": { "description": "the key for this message", "name": "key", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "partition": { "description": "the partition to write to", "name": "partition", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "kafka:topics:write", "pluginAlias": "heroku-kafka", "pluginName": "heroku-kafka", "pluginType": "core", "strict": true, "enableJsonFlag": false, "promptFlagActive": true, "topic": "kafka", "isESM": true, "relativePath": [ "dist", "commands", "kafka", "topics", "write.js" ] } }, "version": "3.0.2" }