CLI Reference¶
phonemenal ships a full command-line interface built on Click with Rich formatting.
Global Options¶
similarity¶
Compare two words using phonetic similarity algorithms.
| Option | Short | Default | Description |
|---|---|---|---|
--algorithm |
-a |
all |
Algorithm to use: ppc, pld, lcs, composite, or all |
--weights |
-w |
1.0 1.0 1.0 |
PPC, PLD, LCS weights for composite scoring |
--json-output |
-j |
— | Output as JSON |
Examples¶
# All algorithms
phonemenal similarity crowd crown
# Specific algorithm
phonemenal similarity crowd crown -a ppc
# Custom weights
phonemenal similarity crowd crown -a composite -w 0.5 2.0 0.5
# JSON output
phonemenal similarity crowd crown -j
homophones¶
Find exact homophones for a word.
| Option | Default | Description |
|---|---|---|
--include-self |
off | Include the input word in results |
Examples¶
variants¶
Generate sound-alike spelling variants.
| Option | Short | Default | Description |
|---|---|---|---|
--morphological |
-m |
off | Include morphological variants (suffix/prefix swaps) |
--no-separators |
— | off | Skip separator permutations |
Examples¶
phonemenal variants flask
phonemenal variants flask --morphological
phonemenal variants my-package --no-separators
split¶
Split a compound word and optionally show homophone permutations.
| Option | Short | Default | Description |
|---|---|---|---|
--permutations |
-p |
off | Show homophone permutations |
--max |
— | 50 |
Maximum permutations to display |
Examples¶
compare¶
Full comparison report between two words.
| Option | Short | Default | Description |
|---|---|---|---|
--weights |
-w |
1.0 1.0 1.0 |
PPC, PLD, LCS weights |
--json-output |
-j |
— | Output as JSON |
Examples¶
phonemenal compare crowd crown
phonemenal compare crowd crown -j
phonemenal compare crowd crown -w 0.5 2.0 0.5
analyze¶
Deep LLM-powered phonetic analysis.
| Option | Short | Default | Description |
|---|---|---|---|
--provider |
-p |
anthropic |
API provider: anthropic or openai |
--model |
-m |
— | Override default model |
--agent |
-a |
— | Use local agent: claude, codex, or path to executable |
--gateway |
-g |
— | OpenAI-compatible gateway URL |
Examples¶
phonemenal analyze numpy
phonemenal analyze numpy --provider openai
phonemenal analyze numpy --model claude-opus-4-20250514
phonemenal analyze numpy --agent claude
phonemenal analyze numpy --gateway https://my-gateway.example.com/v1/chat/completions
prompt¶
Print the raw LLM analysis prompt for a word.
Useful for piping to other tools: