Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Migrating from CLAN

Status: Current Last updated: 2026-05-11 18:58 EDT

This guide helps users of the original CLAN C binaries transition to chatter clan.

Command mapping

Legacy CLAN commands map directly:

LegacyNewNotes
freq file.chachatter clan freq file.cha
mlu +t*CHI file.chachatter clan mlu --speaker CHI file.cha
combo +s"the" file.chachatter clan combo --include-word "the" file.cha
flo file.chachatter clan flo file.cha

Flag translation

Legacy CLAN uses +flag/-flag syntax. Both styles work — the CLI automatically translates:

CLAN flagModern equivalentMeaning
+t*CHI--speaker CHIInclude speaker
-t*CHI--exclude-speaker CHIExclude speaker
+t%mor--tier morInclude dependent tier
-t%gra--exclude-tier graExclude dependent tier
+t@ID="..."--id-filter "..."Filter by @ID fields
+s<word>--include-word <word>Include word
-s<word>--exclude-word <word>Exclude word
+g<label>--gem <label>Include gem
-g<label>--exclude-gem <label>Exclude gem
+z25-125--range 25-125Utterance range
+r6--include-retracingsCount retraced material
+u(default)Merge speakers (always on)
+dN--display-mode NDisplay mode — currently non-functional, see flag-translation.md for the rewriter-honor plan
+k--case-sensitiveCase-sensitive matching — currently non-functional, see flag-translation.md
+fEXT--output-ext EXTOutput file extension — currently non-functional, see flag-translation.md

You can continue using +t*CHI syntax for the functional flags above if you prefer — it works identically.

New capabilities

Features not available in legacy CLAN:

  • JSON and CSV output — --format json or --format csv for programmatic processing
  • Recursive directories — pass a directory path to process all .cha files
  • Unified CLI — all commands under one chatter clan namespace
  • Structured errors — rich diagnostics with file location and context

Known differences

See Why We Diverge and Per-Command Divergences for a complete list. Key points:

  • Output formatting may differ slightly (spacing, alignment)
  • Some legacy CLAN C bugs are fixed rather than replicated
  • Commands not ported are documented in Commands Not Ported