Welcome to Mapchar’s documentation!

Generate wordlists using pattern logic and expressions.

Mapchar is a blazing fast and robust wordlist generator that parses character classes, quantifiers, files, and numeric ranges. It brings a “regex-like” paradigm to generating precise datasets, allowing offensive security professionals and developers to generate specific password lists, payloads, or permutations from a compact syntax.

Installation & Setup:

• Installation
  • Using pipx
  • From Source
• CLI Reference & Flags
  • Usage Syntax
  • Options

Features & Syntax:

• Expressions & Classes
  • Literal Characters
  • Built-in Character Classes
  • Custom Classes and Unions
  • Literal Groups
  • Quantifiers
  • Expression Alternation
  • Escaping
• Ranges & Placeholders
  • Numeric Ranges
  • File Placeholders
  • Inline Macros
• Compression Output
  • Flush Threshold and Performance
  • Compression Comparison
  • Compression Level
  • Practical Guidance
  • Notes
• Advanced Concepts
  • Expression Files (.mapc)
  • Smart Skipping & Chunking
  • Multi-threading
  • Value Bindings

Links:

• GitHub Repository

Why Mapchar?

• Compact Patterns: Describe millions of words in just a few characters.

• Fast: Employs mathematically optimal scaling algorithms yielding tens of thousands of words per second.

• Smart Seeking: Instead of streaming from the beginning, Mapchar can seek directly to a specific word using --start and --end, keeping memory usage constant and small.

• Multi-threaded: Distribute generation intelligently across up to 64 cores.

• Scriptable: Robust .mapc syntax allows breaking rules into easily readable macros and modules.