Monedula
monedula-sim-link docs menu

monedula-sim-link demo

Print a playground URL for a built-in cluster fixture, no cluster needed. Usage and flags for monedula-sim-link demo.

Reference 4 of 5

Reference for monedula-sim-link v0.11.0

Updated 16 October 2026

On this page
usage
monedula-sim-link demo [flags]

Feed a built-in cluster fixture through the same mapping, validation and URL pipeline as connect, without contacting any cluster. The fixture is a single-DC cluster with an offline broker, a partition off the default placement, an ISR gap and non-empty offset ranges. With --producers, the fixture also reports three producers: 1001 and 1002 wrote within the last few minutes (1002 from inside an open transaction, which is shown as an idempotent producer, with a warning), and 1003 wrote three hours ago, outside the default window, so it is left out.

Read-only: this command does not change the cluster.

Flags

FlagTypeDefaultDescription
--clampbool When brokers or partitions exceed the simulator caps, trim deterministically with warnings instead of failing: the 10 lowest broker ids and partitions 0 to 23 of each topic. More topics or consumer groups than the simulator shows never fail: the most eventful are kept, with a warning.
--producersbool Also read the idempotent and transactional producers that wrote lately (DescribeProducers, which needs READ on each selected topic and Kafka 2.8+) and add up to 4 of them to the link. A producer that is neither never appears. A refused or unsupported read is a warning, never a failure.
--producers-windowduration 15m0s With --producers: a producer is active when the record timestamp of its last write to a partition (the client's clock on CreateTime topics, the broker's on LogAppendTime) is within this long before the snapshot. Brokers keep producer state for producer.id.expiration.ms (24h by default), so a longer window shows nothing extra.
--max-records-per-partitionint 8 Cap on synthetic trailing records produced per partition.
--base-urlstring https://monedula.dev/kafka-simulator/playground Playground base URL.
--dry-runbool Also print the decoded action list, name mappings and size param.
--forcebool Emit the URL even when it exceeds the length limit (over-length links risk truncation).

Global flags

None.

Examples

examples
monedula-sim-link demo --dry-run
monedula-sim-link demo --producers --dry-run

Exit codes

CodeMeaning
0The URL was printed.
1The URL build failed. The reason is printed to standard error.
2Usage error: --producers-window is not positive, or a flag could not be parsed.