Go to the home

SCheck Blocklist CLI

Command-line interface tool for interacting with the SCheck Blocklist datasets.

Current Version: 1.1.0

Installation

Install the CLI tool via pip:

pip install scheckbl-cli

---

Usage

The CLI provides multiple commands to interact with blocklists.

Check

scheckbl-cli check <type_name> <category> <keyword>

Example:

scheckbl-cli check phrases vulgarisms "example_word"

---

Find

Searches if any blocklisted entries appear in the given text:

scheckbl-cli find <type_name> <category> <text>

Example:

scheckbl-cli find phrases vulgarisms "This is some sample text."

---

Get

Get the full blocklist and save or output it:

scheckbl-cli get <type_name> <category> [options]

Options:

• -f, --filename NAME — specify filename
• -r, --regex PATTERN — filter results by regex
• -o, --output FILE — save output to a file
• --stdout — print output to standard output

Example:

scheckbl-cli get phrases vulgarisms --stdout

---

Similar

Find blocklist entries similar to a given phrase:

scheckbl-cli similar <type_name> <category> <phrase> [options]

Options:

• -t, --threshold FLOAT — similarity threshold (default 0.6)
• --json — output results as JSON
• -o, --output FILE — save output to a file
• --stdout — print output to standard output

Example:

scheckbl-cli similar phrases vulgarisms "example_phrase" --json

---

Help

For more information on commands and options:

scheckbl-cli --help
scheckbl-cli <command> --help

Click for Github Docs Version