Command-Line Interface (CLI)

Use sluggi from your terminal for fast, flexible slug generation—single or batch, with full Unicode and emoji support.

Installation

Install with CLI support:

pip install .[cli]
# Or from PyPI (if published):
# pip install "sluggi[cli]"

Commands Overview

• sluggi slug <text> Slugify a single string (or use --input for file/stdin).
• sluggi batch --input <file> Batch slugify lines from a file or stdin, with parallel options.
• sluggi bench Benchmark sluggi vs. other slugifiers.
• sluggi info Show version, platform, and shell completion info.

Common Options

• --separator, -s — Set word separator (default: -)
• --custom-map — Custom mapping as JSON (e.g. '{"ä": "ae"}')
• --max-length, -m — Truncate slug to max length
• --stopwords — Comma-separated words to exclude
• --process-emoji/--no-process-emoji — Emoji-to-name conversion (default: off)
• --no-lowercase — Preserve capitalization
• --output, -o — Write result(s) to file
• --parallel (batch) — Enable parallel processing
• --mode (batch) — 'thread', 'process', or 'serial'
• --workers (batch) — Number of worker threads/processes

For all options, run sluggi <command> --help.

Examples

Single string:

sluggi slug "Café déjà vu!"
sluggi slug "Привет мир" --separator _
sluggi slug --input input.txt --output slug.txt

Batch:

sluggi batch --input names.txt --output slugs.txt
cat names.txt | sluggi batch --parallel --mode process

Benchmark:

sluggi bench

Info:

sluggi info

See the Usage and API Reference for Python examples and advanced options.

For CLI-specific issues and limitations, check the FAQ & Troubleshooting.