[{"data":1,"prerenderedAt":634},["ShallowReactive",2],{"docs-nav":3,"docs-page-\u002Fdocs\u002Fget-started\u002Fquickstart":133},[4,27,53,68,83,98,117],{"slug":5,"label":6,"pages":7},"get-started","Get Started",[8,12,17,22],{"path":9,"title":10,"order":11},"\u002Fdocs","Welcome",0,{"path":13,"title":14,"navTitle":15,"order":16},"\u002Fdocs\u002Fget-started\u002Fquickstart","Quickstart",null,1,{"path":18,"title":19,"navTitle":20,"order":21},"\u002Fdocs\u002Fget-started\u002Fconnect-to-a-cluster","Connecting to a Kafka Cluster","Clusters",2,{"path":23,"title":24,"navTitle":25,"order":26},"\u002Fdocs\u002Fget-started\u002Flicense","Licensing and Activation","License",3,{"slug":28,"label":29,"pages":30},"console","Console",[31,35,39,43,48],{"path":32,"title":33,"navTitle":34,"order":16},"\u002Fdocs\u002Fconsole\u002Foverview","Produce and Consume Messages in the Kafka Console","Overview",{"path":36,"title":37,"navTitle":38,"order":21},"\u002Fdocs\u002Fconsole\u002Fconsuming-messages","Kafka Consumer: Reading Messages from a Topic","Consuming",{"path":40,"title":41,"navTitle":42,"order":26},"\u002Fdocs\u002Fconsole\u002Fdecoding-messages","Decoding Kafka Avro and Protobuf Messages","Decoding",{"path":44,"title":45,"navTitle":46,"order":47},"\u002Fdocs\u002Fconsole\u002Fproducing-messages","Kafka Producer: Sending Messages to a Topic","Producing",4,{"path":49,"title":50,"navTitle":51,"order":52},"\u002Fdocs\u002Fconsole\u002Freplay-forward-and-export","Replay and Export Kafka Messages","Replay & export",5,{"slug":54,"label":55,"pages":56},"topics","Topics",[57,60,64],{"path":58,"title":59,"navTitle":34,"order":16},"\u002Fdocs\u002Ftopics\u002Foverview","Browse and Inspect Kafka Topics",{"path":61,"title":62,"navTitle":63,"order":21},"\u002Fdocs\u002Ftopics\u002Fcreate-a-topic","Create a Kafka Topic: Partitions, Replication, and Retention","Create a topic",{"path":65,"title":66,"navTitle":67,"order":26},"\u002Fdocs\u002Ftopics\u002Fpartitions-and-records","Adding Kafka Partitions and Deleting Records","Partitions & records",{"slug":69,"label":70,"pages":71},"schema-registry","Schema Registry",[72,75,79],{"path":73,"title":74,"navTitle":34,"order":16},"\u002Fdocs\u002Fschema-registry\u002Foverview","Browse Kafka Schema Registry Subjects and Versions",{"path":76,"title":77,"navTitle":78,"order":21},"\u002Fdocs\u002Fschema-registry\u002Fnew-versions","Register Kafka Schemas and Publish New Versions","New versions",{"path":80,"title":81,"navTitle":82,"order":26},"\u002Fdocs\u002Fschema-registry\u002Fmock-and-lab","Avro Schema Validator and Mock Data Generator","Mock & Lab",{"slug":84,"label":85,"pages":86},"consumer-groups","Consumer Groups",[87,90,94],{"path":88,"title":89,"navTitle":34,"order":16},"\u002Fdocs\u002Fconsumer-groups\u002Foverview","Browse Kafka Consumer Groups and Assignments",{"path":91,"title":92,"navTitle":93,"order":21},"\u002Fdocs\u002Fconsumer-groups\u002Flag","Monitor Kafka Consumer Lag","Lag",{"path":95,"title":96,"navTitle":97,"order":26},"\u002Fdocs\u002Fconsumer-groups\u002Freset-offsets","Reset Kafka Consumer Group Offsets","Reset offsets",{"slug":99,"label":100,"pages":101},"data-clone","Data Clone",[102,105,109,113],{"path":103,"title":104,"navTitle":34,"order":16},"\u002Fdocs\u002Fdata-clone\u002Foverview","Clone Kafka Topics Between Clusters",{"path":106,"title":107,"navTitle":108,"order":21},"\u002Fdocs\u002Fdata-clone\u002Fscope-and-range","Configure Kafka Topic Cloning","Scope & range",{"path":110,"title":111,"navTitle":112,"order":26},"\u002Fdocs\u002Fdata-clone\u002Fmasking","Mask Sensitive Data in Kafka Messages","Masking",{"path":114,"title":115,"navTitle":116,"order":47},"\u002Fdocs\u002Fdata-clone\u002Fpre-flight","Run Pre-flight Checks Before a Kafka Data Clone","Pre-flight",{"slug":118,"label":119,"pages":120},"operate","Operate",[121,125,129],{"path":122,"title":123,"navTitle":124,"order":16},"\u002Fdocs\u002Foperate\u002Fbrokers","Inspect Kafka Brokers and Cluster Configuration","Brokers",{"path":126,"title":127,"navTitle":128,"order":21},"\u002Fdocs\u002Foperate\u002Faccess-control","Inspect Kafka ACLs and Simulate Access","Access Control",{"path":130,"title":131,"navTitle":132,"order":26},"\u002Fdocs\u002Foperate\u002Factivity-logs","Review Kafka Changes in Kafma Activity Logs","Activity Logs",{"id":134,"title":14,"body":135,"description":625,"extension":626,"lastUpdated":627,"meta":628,"navTitle":15,"navigation":629,"order":16,"path":13,"seo":630,"sitemap":631,"stem":632,"__hash__":633},"docs\u002Fdocs\u002Fget-started\u002Fquickstart.md",{"type":136,"value":137,"toc":617},"minimark",[138,143,147,276,279,402,405,414,418,441,449,464,475,485,489,496,504,511,517,521,524,532,547,550,554,564,570,589,593,613],[139,140,142],"h2",{"id":141},"_1-install-kafma","1. Install Kafma",[144,145,146],"p",{},"Choose the package for your operating system and architecture:",[148,149,150,166],"table",{},[151,152,153],"thead",{},[154,155,156,160,163],"tr",{},[157,158,159],"th",{},"Platform",[157,161,162],{},"Package",[157,164,165],{},"Download",[167,168,169,196,218,238,257],"tbody",{},[154,170,171,175,181],{},[172,173,174],"td",{},"macOS",[172,176,177],{},[178,179,180],"code",{},".dmg",[172,182,183,190,191],{},[184,185,189],"a",{"href":186,"rel":187},"https:\u002F\u002Fgithub.com\u002Fkafma-app\u002Fkafma\u002Freleases\u002Flatest\u002Fdownload\u002FKafma-mac-arm64.dmg",[188],"nofollow","Apple Silicon"," · ",[184,192,195],{"href":193,"rel":194},"https:\u002F\u002Fgithub.com\u002Fkafma-app\u002Fkafma\u002Freleases\u002Flatest\u002Fdownload\u002FKafma-mac-x64.dmg",[188],"Intel",[154,197,198,201,206],{},[172,199,200],{},"Windows",[172,202,203],{},[178,204,205],{},".exe",[172,207,208,190,213],{},[184,209,212],{"href":210,"rel":211},"https:\u002F\u002Fgithub.com\u002Fkafma-app\u002Fkafma\u002Freleases\u002Flatest\u002Fdownload\u002FKafma-windows-x64.exe",[188],"x64",[184,214,217],{"href":215,"rel":216},"https:\u002F\u002Fgithub.com\u002Fkafma-app\u002Fkafma\u002Freleases\u002Flatest\u002Fdownload\u002FKafma-windows-arm64.exe",[188],"ARM64",[154,219,220,223,228],{},[172,221,222],{},"Linux",[172,224,225],{},[178,226,227],{},".deb",[172,229,230,190,234],{},[184,231,212],{"href":232,"rel":233},"https:\u002F\u002Fgithub.com\u002Fkafma-app\u002Fkafma\u002Freleases\u002Flatest\u002Fdownload\u002FKafma-linux-x86_64.deb",[188],[184,235,217],{"href":236,"rel":237},"https:\u002F\u002Fgithub.com\u002Fkafma-app\u002Fkafma\u002Freleases\u002Flatest\u002Fdownload\u002FKafma-linux-arm64.deb",[188],[154,239,240,242,247],{},[172,241,222],{},[172,243,244],{},[178,245,246],{},".rpm",[172,248,249,190,253],{},[184,250,212],{"href":251,"rel":252},"https:\u002F\u002Fgithub.com\u002Fkafma-app\u002Fkafma\u002Freleases\u002Flatest\u002Fdownload\u002FKafma-linux-x86_64.rpm",[188],[184,254,217],{"href":255,"rel":256},"https:\u002F\u002Fgithub.com\u002Fkafma-app\u002Fkafma\u002Freleases\u002Flatest\u002Fdownload\u002FKafma-linux-arm64.rpm",[188],[154,258,259,261,266],{},[172,260,222],{},[172,262,263],{},[178,264,265],{},".AppImage",[172,267,268,190,272],{},[184,269,212],{"href":270,"rel":271},"https:\u002F\u002Fgithub.com\u002Fkafma-app\u002Fkafma\u002Freleases\u002Flatest\u002Fdownload\u002FKafma-linux-x86_64.AppImage",[188],[184,273,217],{"href":274,"rel":275},"https:\u002F\u002Fgithub.com\u002Fkafma-app\u002Fkafma\u002Freleases\u002Flatest\u002Fdownload\u002FKafma-linux-arm64.AppImage",[188],[144,277,278],{},"Choose Apple Silicon for an M-series Mac or Intel for an Intel Mac; most Windows\nand Linux machines use x64.",[280,281,282,292,308],"ul",{},[283,284,285,288,289,291],"li",{},[286,287,174],"strong",{}," — open the ",[178,290,180],{}," and drag Kafma into Applications.",[283,293,294,296,297,299,300,303,304,307],{},[286,295,200],{}," — run the ",[178,298,205],{},". If SmartScreen appears, choose ",[286,301,302],{},"More info",",\nthen ",[286,305,306],{},"Run anyway",".",[283,309,310,312,313,315,316,318,319,322,323,326,327,330,331,358,360,361,378,380,381],{},[286,311,222],{}," — install the ",[178,314,227],{}," or ",[178,317,246],{}," with your package manager, or run the\nAppImage directly. The examples below use x64; replace ",[178,320,321],{},"x86_64"," with ",[178,324,325],{},"arm64","\nfor ARM.",[328,329],"br",{},"Debian or Ubuntu:",[332,333,338],"pre",{"className":334,"code":335,"language":336,"meta":337,"style":337},"language-bash shiki shiki-themes kafma-dark","sudo apt install .\u002FKafma-linux-x86_64.deb\n","bash","",[178,339,340],{"__ignoreMap":337},[341,342,344,348,352,355],"span",{"class":343,"line":16},"line",[341,345,347],{"class":346},"sLaUg","sudo",[341,349,351],{"class":350},"sJl8Q"," apt",[341,353,354],{"class":350}," install",[341,356,357],{"class":350}," .\u002FKafma-linux-x86_64.deb\n",[328,359],{},"Fedora or RHEL:",[332,362,364],{"className":334,"code":363,"language":336,"meta":337,"style":337},"sudo dnf install .\u002FKafma-linux-x86_64.rpm\n",[178,365,366],{"__ignoreMap":337},[341,367,368,370,373,375],{"class":343,"line":16},[341,369,347],{"class":346},[341,371,372],{"class":350}," dnf",[341,374,354],{"class":350},[341,376,377],{"class":350}," .\u002FKafma-linux-x86_64.rpm\n",[328,379],{},"AppImage:",[332,382,384],{"className":334,"code":383,"language":336,"meta":337,"style":337},"chmod +x Kafma-linux-x86_64.AppImage\n.\u002FKafma-linux-x86_64.AppImage\n",[178,385,386,397],{"__ignoreMap":337},[341,387,388,391,394],{"class":343,"line":16},[341,389,390],{"class":346},"chmod",[341,392,393],{"class":350}," +x",[341,395,396],{"class":350}," Kafma-linux-x86_64.AppImage\n",[341,398,399],{"class":343,"line":21},[341,400,401],{"class":346},".\u002FKafma-linux-x86_64.AppImage\n",[144,403,404],{},"Open Kafma. It shows Welcome until you add your first cluster; after that, the\nsame page becomes Home.",[144,406,407],{},[408,409],"img",{"alt":410,"height":411,"src":412,"width":413},"The Kafma Welcome screen on first launch, before any cluster is connected",1520,"https:\u002F\u002Fmedia.kafma.app\u002Fdocs\u002Fget-started\u002Fquickstart\u002Fwelcome.png",2160,[139,415,417],{"id":416},"_2-connect-to-a-kafka-cluster","2. Connect to a Kafka cluster",[144,419,420,421,424,425,428,429,432,433,436,437,440],{},"Choose a shortcut on Welcome to open the New Cluster form. ",[286,422,423],{},"Local Docker"," uses\n",[178,426,427],{},"localhost:9092"," with no authentication; ",[286,430,431],{},"Confluent Cloud"," and ",[286,434,435],{},"AWS MSK","\npreselect their authentication settings; ",[286,438,439],{},"Custom Configuration"," starts empty.",[144,442,443],{},[408,444],{"alt":445,"height":446,"src":447,"width":448},"The New Cluster form in Kafma, connecting to a local Kafka broker at localhost:9092 with no authentication",1440,"https:\u002F\u002Fmedia.kafma.app\u002Fdocs\u002Fget-started\u002Fquickstart\u002Fadd-connection.png",1554,[144,450,451,452,455,456,459,460,463],{},"Set ",[286,453,454],{},"Environment"," so production clusters stand out. Choosing ",[286,457,458],{},"Production","\nenables ",[286,461,462],{},"Read-Only",", which blocks writes; turn it off only when you intend to\nmodify the cluster.",[144,465,466,467,470,471,474],{},"Choose ",[286,468,469],{},"Test Connection"," to verify the settings, then ",[286,472,473],{},"Save"," to add the\ncluster.",[144,476,477,478,481,482,307],{},"Kafma Free supports one connection; ",[184,479,480],{"href":23},"Pro"," removes the\nlimit. For Confluent Cloud, Amazon MSK, and other authentication options, see\n",[184,483,484],{"href":18},"Connect to a cluster",[139,486,488],{"id":487},"_3-open-a-topic","3. Open a topic",[144,490,491,492,495],{},"Select ",[286,493,494],{},"+",", search for a topic, and press Enter to open it.",[144,497,498],{},[408,499],{"alt":500,"height":501,"src":502,"width":503},"Kafma's topic picker filtering a list of Kafka topics by name, with partition and replica counts",1264,"https:\u002F\u002Fmedia.kafma.app\u002Fdocs\u002Fget-started\u002Fquickstart\u002Fopen-topic.png",1556,[144,505,506,507,510],{},"Results show partition and replica counts. Topics whose names start with ",[178,508,509],{},"__","\nare hidden by default.",[144,512,513,514,307],{},"If the cluster has no topics, ",[184,515,516],{"href":61},"create one",[139,518,520],{"id":519},"_4-read-and-produce-messages","4. Read and produce messages",[144,522,523],{},"Open a topic to load its latest messages and producer in the same Console tab.",[144,525,526],{},[408,527],{"alt":528,"height":529,"src":530,"width":531},"A Kafka topic open in Kafma, listing JSON messages above and the producer composing the next one below",1446,"https:\u002F\u002Fmedia.kafma.app\u002Fdocs\u002Fget-started\u002Fquickstart\u002Ffirst-messages.png",1560,[144,533,534,535,538,539,542,543,546],{},"Enter a key and value, then choose ",[286,536,537],{},"Produce",". Refresh the message list to see\nthe new record, or switch ",[286,540,541],{},"From"," to ",[286,544,545],{},"Live"," before producing to watch it\narrive automatically.",[144,548,549],{},"Choose a format for the key and value. If the topic has a registered schema,\nselect it to validate and serialize the payload before sending.",[139,551,553],{"id":552},"home-and-global-search","Home and global search",[144,555,556,557,560,561,307],{},"Home keeps pinned topics, schema subjects, and consumer groups in ",[286,558,559],{},"Watchlist",",\nand recently opened resources in ",[286,562,563],{},"Recents",[144,565,566],{},[408,567],{"alt":568,"height":411,"src":569,"width":413},"The Kafma home screen showing pinned Kafka topics and consumer groups in the Watchlist alongside recently opened resources","https:\u002F\u002Fmedia.kafma.app\u002Fdocs\u002Fget-started\u002Fquickstart\u002Fhome-watchlist.png",[144,571,572,573,576,577,580,581,584,585,588],{},"Use ",[286,574,575],{},"⌘P"," on macOS or ",[286,578,579],{},"Ctrl+P"," on Windows and Linux to search topics, schema\nsubjects, and consumer groups across connected clusters. Use ",[286,582,583],{},"⌘D"," or\n",[286,586,587],{},"Ctrl+D"," to pin a result.",[139,590,592],{"id":591},"next-steps","Next steps",[280,594,595,601,607],{},[283,596,597,600],{},[184,598,599],{"href":32},"Console overview"," — topic tabs, decoding, replay,\nforwarding, and export.",[283,602,603,606],{},[184,604,605],{"href":36},"Consuming messages"," — filters, Live mode,\nand Watch Group.",[283,608,609,612],{},[184,610,611],{"href":44},"Producing messages"," — formats, schemas,\npartitions, headers, and the timed loop.",[614,615,616],"style",{},"html pre.shiki code .sLaUg, html code.shiki .sLaUg{--shiki-default:#FFFFFF}html pre.shiki code .sJl8Q, html code.shiki .sJl8Q{--shiki-default:#83CFAE}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}",{"title":337,"searchDepth":26,"depth":26,"links":618},[619,620,621,622,623,624],{"id":141,"depth":21,"text":142},{"id":416,"depth":21,"text":417},{"id":487,"depth":21,"text":488},{"id":519,"depth":21,"text":520},{"id":552,"depth":21,"text":553},{"id":591,"depth":21,"text":592},"Install Kafma on macOS, Windows, or Linux, connect to a Kafka cluster, and start consuming and producing messages from one desktop workspace.","md","2026-08-01",{},true,{"title":14,"description":625},{"loc":13},"docs\u002Fget-started\u002Fquickstart","ekpihXSBCNuo-Drb2kqy2MqJewdzrl5R6zlvgsSZa-g",1785561255755]