Skip to Content
We are live but in Staging 🎉
PipelinesCLI Guidedodil k3 pipeline

dodil k3 pipeline

Manage pipelines. Full CRUD — create, list, get, update, delete. Mirrors Pipelines — API Reference.

A pipeline is a Scriptum template + options + optional destination. See Core Concepts → Pipeline for the type signature.

dodil k3 pipeline create

dodil k3 pipeline create [name] -b BUCKET --scriptum TEMPLATE_NAME

Creates a pipeline that references an existing Scriptum script by name. To spawn a fresh script from a template ID instead, use the API’s spawn_from_template field — the CLI doesn’t expose it directly today.

FlagShortTypeDescription
--bucket-bstringRequired (persistent on the group). Bucket the pipeline lives in.
--scriptumstringScriptum template / script name to reference

Example:

# Text / PDF / docx → vector collection (RAG ingest) dodil k3 pipeline create embed-contracts \ -b kb-prod \ --scriptum text_embedding_index \ -o json # Other production templates worth knowing — see api-reference/templates#the-catalog: # object_embedding_index, code_embedding_index, visual_embedding_index, face_embedding_index # entity_pii_extraction, ocr_extraction, summarization, classification # audio_transcription, object_detection, image_understanding, …

Capture pipeline_id from the JSON response for the next step (binding it to a rule).

Destination binding (store_entity_id) and per-pipeline options aren’t on create flags today. Set them via update or the API.

dodil k3 pipeline list

dodil k3 pipeline list -b BUCKET

Lists all pipelines in the bucket.

FlagShortTypeDescription
--bucket-bstringRequired. Bucket scope.

Example:

dodil k3 pipeline list -b kb-prod -o json | jq '.pipelines[] | {pipelineId, name, storeEntityKind, storeEntityName}'

Filter flags (store_entity_kind, store_entity_id) exist on the API but aren’t surfaced as CLI flags today.

dodil k3 pipeline get

dodil k3 pipeline get [pipeline_id] -b BUCKET

Fetches one pipeline by ID.

FlagShortTypeDescription
--bucket-bstringRequired.

Example:

dodil k3 pipeline get pipe_a1b2... -b kb-prod -o json

dodil k3 pipeline update

dodil k3 pipeline update [pipeline_id] -b BUCKET [flags]

Patches mutable fields. At least one update flag is required (the CLI errors out otherwise — refuses no-op updates).

FlagTypeDescription
--namestringRename the pipeline
--scriptumstringReplace the Scriptum template reference
--store-entity-idstringRe-bind to a different destination (pass empty to make pipeline free)
--options-jsonstringJSON object of pipeline options (full replace)

Examples:

# Rename dodil k3 pipeline update pipe_a1b2... -b kb-prod --name embed-contracts-v2 # Re-bind to a different vector collection dodil k3 pipeline update pipe_a1b2... -b kb-prod --store-entity-id ent_new... # Tighten chunking parameters dodil k3 pipeline update pipe_a1b2... -b kb-prod \ --options-json '{"chunk_size":"1500","chunk_overlap":"200"}' # Multiple at once dodil k3 pipeline update pipe_a1b2... -b kb-prod \ --name embed-contracts-v2 \ --options-json '{"chunk_size":"1500"}'

--options-json is a full replace of the options map, not a merge. Pass the complete set of options you want to keep.

dodil k3 pipeline delete

dodil k3 pipeline delete [pipeline_id] -b BUCKET

Deletes the pipeline. Does not cascade — any rule whose pipeline_id was this pipeline will keep existing with an empty binding and will fail at ingest time. Either delete dependent rules first or re-bind them with dodil k3 ingest against another pipeline.

Example:

dodil k3 pipeline delete pipe_a1b2... -b kb-prod

See also