classifyre-cli 0.4.31

Classifyre CLI — scan and classify unstructured data sources

CLI Application

Python CLI for source extraction, detector execution, and batched output delivery.

Setup

cd /unstructured/apps/cli
uv sync
# Optional if you want an activated shell instead of `uv run ...`:
source .venv/bin/activate

Optional detector groups:

uv sync --group detectors
# or specific groups: --group secrets --group pii --group threat ...

Command Syntax

Use the thin wrapper:

uv run main.py <command> <recipe.json> [options]

Or direct module entrypoint:

uv run python -m src.main <command> <recipe.json> [options]

Commands:

• test - test source connection.
• discover - discover source resources.
• extract - run extraction and emit batched output.
• sandbox - run sandbox parsing/detectors for a local file.

Extract Output Model

Extraction always emits in batches. Recipes do not contain output configuration; output is controlled by CLI flags and environment variables.

Output types:

• console - emits NDJSON envelopes to stdout.
• file - appends NDJSON envelopes to a file.
• rest - pushes batches to API endpoints and finalizes run.

Default behavior:

• If source_id is present (--source-id or SOURCE_ID env), default output is rest.
• Otherwise default output is console.
• Default batch size is 20.

CLI Options

Global/common:

• --debug - enable debug logging.
• --detectors-file <path> - sandbox only.

Extract output options:

• --output-type rest|file|console
• --output-batch-size <int>
• --output-rest-url <url>
• --output-file-path <path>
• --source-id <uuid>
• --runner-id <uuid>
• --managed-runner (REST only; runner lifecycle managed by API orchestrator)

Environment fallbacks:

• SOURCE_ID, RUNNER_ID
• CLASSIFYRE_OUTPUT_TYPE, CLASSIFYRE_OUTPUT_BATCH_SIZE
• CLASSIFYRE_OUTPUT_REST_URL, CLASSIFYRE_OUTPUT_REST_TIMEOUT_SEC
• CLASSIFYRE_OUTPUT_FILE_PATH
• API_URL (fallback base URL for REST output)

Practical Examples

1) Console output (quick local test)

uv run main.py extract ./wordpress-recipe.json --output-type console --output-batch-size 1

You will see NDJSON lines like:

• {"event":"batch", ...}
• {"event":"finish", ...}

2) File output

uv run main.py extract ./wordpress-recipe.json \
  --output-type file \
  --output-file-path /tmp/classifyre-assets.ndjson \
  --output-batch-size 20

3) REST output (manual CLI to backend)

uv run main.py extract ./wordpress-recipe.json \
  --output-type rest \
  --source-id <source_uuid>

Notes:

• --runner-id optional for manual runs. If omitted, CLI creates external runner automatically.
• --output-rest-url is optional. If omitted, CLI uses CLASSIFYRE_OUTPUT_REST_URL, then API_URL, then http://localhost:8000.
• --managed-runner should be used only for API-orchestrated runs where runner already exists.

4) REST output with explicit runner (managed/orchestrated style)

uv run main.py extract ./wordpress-recipe.json \
  --output-type rest \
  --source-id <source_uuid> \
  --runner-id <runner_uuid> \
  --managed-runner

5) Full extract command with all output flags

uv run main.py extract ./wordpress-recipe.json \
  --output-type rest \
  --output-batch-size 20 \
  --output-rest-url http://localhost:8000 \
  --output-file-path /tmp/classifyre-assets.ndjson \
  --source-id <source_uuid> \
  --runner-id <runner_uuid> \
  --managed-runner

Use --output-file-path only when --output-type file.

Dev Scripts

• bun run dev - run CLI quickly.
• bun run lint - ruff format/check.
• bun run check-types - mypy.
• bun run test - pytest suite.