Getting Started

Installation

Install from npm:

npm install malarky

Or from source:

git clone <repo>
cd malarky
npm install
npm run build

Your first generator

The simplest setup requires only a faker adapter. The built-in SimpleFakerAdapter provides a fixed set of English words with no external dependencies.

import { TextGenerator, SimpleFakerAdapter } from 'malarky';

const generator = new TextGenerator({
  fakerAdapter: new SimpleFakerAdapter(),
});

generator.setSeed(42);

Generate a sentence

console.log(generator.sentence());
// "Generally, the change called."

You can request a specific sentence type:

generator.sentence({ type: 'question' });
// "Does the team deliver results?"

generator.sentence({ type: 'compound' });
// "The strategy evolved, and the metrics improved."

Generate a paragraph

console.log(generator.paragraph({ sentences: 3 }));
// Three sentences of plausible nonsense

Generate a text block

console.log(generator.textBlock({ paragraphs: 2 }));
// Two paragraphs of malarky

CLI quick start

After installing globally (npm install -g malarky) or locally, the malarky command is available. With a local install, use npx malarky or npm run cli --.

# Generate a sentence
malarky sentence

# Generate a deterministic question
malarky sentence --seed 42 --type question

# Generate a paragraph with a corporate lexicon
malarky paragraph --sentences 5 --lexicon ./corp.json --archetype corporate

# Apply Pig Latin transform and output as JSON
malarky sentence --seed 42 --transform pigLatin --json

What next?

• CLI Reference – All commands, options, and examples
• Lexicons – Steer generation with custom vocabularies
• Output Transforms – Modify output with Pig Latin, leet speak, pirate, and more
• API Reference – Full TypeScript API documentation
• Configuration – Tune sentence lengths, type weights, and complexity