Skip to content

🖥️ Wurzel CLI Reference

The Wurzel CLI provides a powerful command-line interface for managing and executing ETL pipelines for RAG systems.

Quick Start

# Install wurzel
pip install wurzel

# Run a step
wurzel run wurzel.steps.manual_markdown.ManualMarkdownStep --inputs ./data --output ./out

# Inspect a step
wurzel inspect wurzel.steps.manual_markdown.ManualMarkdownStep

# Generate a pipeline
wurzel generate wurzel.steps.manual_markdown.ManualMarkdownStep

CLI Commands Reference

The following documentation is automatically generated from the Wurzel CLI code:

wurzel

Global settings, main.

Usage

wurzel [OPTIONS] COMMAND [ARGS]...

Arguments

No arguments available

Options

Name Description Required Default
--log-level TEXT [default: INFO] No -
--install-completion Install completion for the current shell. No -
--show-completion Show completion for the current shell, to copy it or customize the installation. No -
--help Show this message and exit. No -

Commands

Name Description
run Run a step
inspect Display information about a step
generate generate a pipeline

Sub Commands

wurzel run

Run a step

Usage

wurzel run [OPTIONS] STEP

Arguments

Name Description Required
STEP module path to step Yes

Options

Name Description Required Default
-o, --output DIRECTORY Folder with outputs [default: -2025-10-01T15:56:36.269] No -
-i, --inputs DIRECTORY input folders No -
-e, --executor TEXT executor to use [default: BaseStepExecutor] No -
--encapsulate-env / --no-encapsulate-env [default: encapsulate-env] No -
--help Show this message and exit. No -

wurzel inspect

Display information about a step

Usage

wurzel inspect [OPTIONS] STEP

Arguments

Name Description Required
STEP module path to step Yes

Options

Name Description Required Default
--gen-env / --no-gen-env [default: no-gen-env] No -
--help Show this message and exit. No -

wurzel generate

generate a pipeline

Usage

wurzel generate [OPTIONS] PIPELINE

Arguments

Name Description Required
PIPELINE module path to step or pipeline(which is a chained step) Yes

Options

Name Description Required Default
-b, --backend TEXT backend to use [default: DvcBackend] No -
--help Show this message and exit. No -

Usage Examples

Running Steps

# Basic usage
wurzel run wurzel.steps.manual_markdown.ManualMarkdownStep \
    --inputs ./markdown-files \
    --output ./processed-output

# With custom executor
wurzel run wurzel.steps.manual_markdown.ManualMarkdownStep \
    --inputs ./markdown-files \
    --output ./processed-output \
    --executor PrometheusStepExecutor

# Multiple input folders
wurzel run wurzel.steps.splitter.SimpleSplitterStep \
    --inputs ./docs \
    --inputs ./markdown \
    --inputs ./pdfs \
    --output ./split-output

Inspecting Steps

# Basic inspection
wurzel inspect wurzel.steps.manual_markdown.ManualMarkdownStep

# Generate environment file
wurzel inspect wurzel.steps.manual_markdown.ManualMarkdownStep --gen-env

Generating Pipelines

# Generate DVC pipeline (default)
wurzel generate wurzel.steps.manual_markdown.ManualMarkdownStep

# Generate Argo pipeline
wurzel generate wurzel.steps.manual_markdown.ManualMarkdownStep --backend ArgoBackend

Step Auto-Discovery

The CLI supports intelligent auto-completion for step names using TAB completion:

wurzel run <TAB>                    # Shows all available steps
wurzel run wurzel.steps.<TAB>       # Shows wurzel built-in steps
wurzel run mysteps.<TAB>            # Shows your custom steps

The auto-completion discovers:

  1. Built-in Wurzel steps - Available in the wurzel.steps.* namespace
  2. User-defined steps - TypedStep classes in your current project

Performance Optimizations

The CLI auto-completion is optimized for speed:

  • ✅ Fast scanning - Only scans relevant directories
  • ✅ Smart exclusions - Skips .venv, tests, docs, __pycache__, etc.
  • ✅ AST parsing - Analyzes code without importing modules
  • ✅ Depth limiting - Prevents deep directory traversal