Reference
Complete embedding CLI command reference
Exact syntax and effects for every registered embedding command.
This page is generated from the same machine-readable authority used by CLI help. Do not edit it manually.
| Command | Exact syntax | Required inputs | Configuration | I/O | Mutation/overwrite | Network/cost | Error families | Contract/version |
|---|---|---|---|---|---|---|---|---|
embed data create |
finetuning embed data create [--out <path|->] [--json] [--dry-run] [--force] |
no input; –out only when writing a file | optional task/column mapping and provenance flags | empty dataset to –out; summary on stdout | writes only explicit output; existing output requires –force | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed data import |
finetuning embed data import [input|-] [--out <path|->] [--task <task>] [--columns <map>] [--json] [--dry-run] [--force] |
input or stdin; mapping required when source is not canonical | optional task/column mapping and provenance flags | input path or stdin; output path or stdout | writes only explicit output; existing output requires –force | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed data convert |
finetuning embed data convert [input|-] [--out <path|->] [--task <task>] [--columns <map>] [--json] [--dry-run] [--force] |
input or stdin; mapping required when source is not canonical | optional task/column mapping and provenance flags | input path or stdin; output path or stdout | writes only explicit output; existing output requires –force | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed data validate |
finetuning embed data validate [input|-] [--task <task>] [--columns <map>] [--json] |
input or stdin | optional task/column mapping and provenance flags | input path or stdin; result on stdout | read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed data inspect |
finetuning embed data inspect [input|-] [--task <task>] [--columns <map>] [--json] |
input or stdin | optional task/column mapping and provenance flags | input path or stdin; result on stdout | read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed data split |
finetuning embed data split [input|-] --salt <value> [--out <path|->] [--json] [--dry-run] [--force] |
input or stdin and –salt | optional task/column mapping and provenance flags | input path or stdin; output path or stdout | writes only explicit output; existing output requires –force | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed data dedupe |
finetuning embed data dedupe [input|-] [--threshold <0..1>] [--out <path|->] [--json] [--dry-run] [--force] |
input or stdin | optional task/column mapping and provenance flags | input path or stdin; output path or stdout | writes only explicit output; existing output requires –force | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed data freeze |
finetuning embed data freeze [input|-] --out <directory> [--json] [--dry-run] [--force] |
input or stdin and –out directory | optional task/column mapping and provenance flags | frozen manifest/records directory | writes only explicit output; existing output requires –force | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed data export |
finetuning embed data export [input|-] [--out <path|->] [--json] [--dry-run] [--force] |
input or stdin | optional task/column mapping and provenance flags | input path or stdin; output path or stdout | writes only explicit output; existing output requires –force | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed generate queries |
finetuning embed generate queries [--limit <n>] [--json] [--dry-run] |
none | optional –limit controls the deterministic estimate | JSON result on stdout; diagnostics on stderr | read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed generate documents |
finetuning embed generate documents [--limit <n>] [--json] [--dry-run] |
none | optional –limit controls the deterministic estimate | JSON result on stdout; diagnostics on stderr | read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed generate pairs |
finetuning embed generate pairs [--limit <n>] [--json] [--dry-run] |
none | optional –limit controls the deterministic estimate | JSON result on stdout; diagnostics on stderr | read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed mine negatives |
finetuning embed mine negatives [--json] [--dry-run] |
none | no config or limit is consumed | JSON result on stdout; diagnostics on stderr | read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed distill vectors |
finetuning embed distill vectors --config <path> --input <path> [--state <path>] [--json] [--dry-run] |
–config; –input unless –dry-run | versioned distillation config | JSON result on stdout; diagnostics on stderr | non-dry run writes state; refuses an existing state | current deterministic fake services only; reports network false | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed distill scores |
finetuning embed distill scores --config <path> --input <path> [--state <path>] [--json] [--dry-run] |
–config; –input unless –dry-run | versioned distillation config | JSON result on stdout; diagnostics on stderr | non-dry run writes state; refuses an existing state | current deterministic fake services only; reports network false | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed distill rankings |
finetuning embed distill rankings --config <path> --input <path> [--state <path>] [--json] [--dry-run] |
–config; –input unless –dry-run | versioned distillation config | JSON result on stdout; diagnostics on stderr | non-dry run writes state; refuses an existing state | current deterministic fake services only; reports network false | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed distill run |
finetuning embed distill run --config <path> --input <path> [--state <path>] [--json] [--dry-run] |
–config; –input unless –dry-run | versioned distillation config | JSON result on stdout; diagnostics on stderr | non-dry run writes state; refuses an existing state | current deterministic fake services only; reports network false | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed distill plan |
finetuning embed distill plan --config <path> [--state <path>] [--json] [--dry-run] |
–config | versioned distillation config | JSON result on stdout; diagnostics on stderr | read-only | current deterministic planning only; reports network false | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed distill resume |
finetuning embed distill resume --config <path> --input <path> [--state <path>] [--json] [--dry-run] |
–config; –input unless –dry-run; existing state for non-dry resume | versioned distillation config | JSON result on stdout; diagnostics on stderr | continues and rewrites the selected state | current deterministic fake services only; reports network false | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed distill status |
finetuning embed distill status [--state <path>] [--json] |
existing state path or default embedding-distillation-state.json | no config is read | JSON result on stdout; diagnostics on stderr | read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed models list |
finetuning embed models list [--id <id>] [--json] [--quiet] |
none; optional –id narrows the registry result | committed model/recipe registries | JSON result on stdout; diagnostics on stderr | read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed models info |
finetuning embed models info [--id <id>] [--json] [--quiet] |
none; optional –id narrows the registry result | committed model/recipe registries | JSON result on stdout; diagnostics on stderr | read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed models license |
finetuning embed models license [--id <id>] [--json] [--quiet] |
none; optional –id narrows the registry result | committed model/recipe registries | JSON result on stdout; diagnostics on stderr | read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed models compat |
finetuning embed models compat [--id <id>] [--json] [--quiet] |
none; optional –id narrows the registry result | committed model/recipe registries | JSON result on stdout; diagnostics on stderr | read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed recipes list |
finetuning embed recipes list [--id <id>] [--json] [--quiet] |
none; optional –id narrows the registry result | committed model/recipe registries | JSON result on stdout; diagnostics on stderr | read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed recipes show |
finetuning embed recipes show [--id <id>] [--json] [--quiet] |
none; optional –id narrows the registry result | committed model/recipe registries | JSON result on stdout; diagnostics on stderr | read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed recipes lock |
finetuning embed recipes lock [--id <id>] [--json] [--quiet] |
none; optional –id narrows the registry result | committed model/recipe registries | JSON result on stdout; diagnostics on stderr | read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed train init |
finetuning embed train init --config <path> [--json] [--quiet] [--dry-run] |
–config | required versioned –config; CLI overrides environment references then config | JSON result on stdout; diagnostics on stderr | read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed train validate |
finetuning embed train validate --config <path> [--json] [--quiet] [--dry-run] |
–config | required versioned –config; CLI overrides environment references then config | JSON result on stdout; diagnostics on stderr | read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed train estimate |
finetuning embed train estimate --config <path> [--json] [--quiet] [--dry-run] |
–config | required versioned –config; CLI overrides environment references then config | JSON result on stdout; diagnostics on stderr | read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed train evaluate |
finetuning embed train evaluate --config <path> [--json] [--quiet] [--dry-run] |
–config | required versioned –config; CLI overrides environment references then config | JSON result on stdout; diagnostics on stderr | read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed train run |
finetuning embed train run --config <path> [--json] [--quiet] [--dry-run] |
–config | required versioned –config; CLI overrides environment references then config | JSON result on stdout; diagnostics on stderr | non-dry run writes resolved spec, checkpoints, and artifacts in configured output | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed train resume |
finetuning embed train resume --config <path> [--checkpoint <path>] [--json] [--quiet] [--dry-run] |
–config and a checkpoint from CLI or config | required versioned –config; CLI overrides environment references then config | JSON result on stdout; diagnostics on stderr | non-dry resume writes within configured output | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed train status |
finetuning embed train status --config <path> [--checkpoint <path>] [--json] [--quiet] [--dry-run] |
–config; optional checkpoint classifies resume state | required versioned –config; CLI overrides environment references then config | JSON result on stdout; diagnostics on stderr | read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed train export |
finetuning embed train export --config <path> [--json] [--quiet] [--dry-run] |
–config | required versioned –config; CLI overrides environment references then config | JSON result on stdout; diagnostics on stderr | non-dry export writes configured artifact output | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed train inspect |
finetuning embed train inspect --config <path> [--artifact <path>] [--json] [--quiet] [--dry-run] |
–config and an artifact from CLI or config | required versioned –config; CLI overrides environment references then config | JSON result on stdout; diagnostics on stderr | verifies artifact; runner path is read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed evaluate run |
finetuning embed evaluate run --config <path> [--json] [--quiet] [--dry-run] |
–config | required versioned –config; CLI overrides environment references then config | JSON result on stdout; diagnostics on stderr | non-dry run writes the configured evaluation report | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed evaluate compare |
finetuning embed evaluate compare --config <path> --left <report> --right <report> [--json] [--quiet] |
–config, –left, and –right | required versioned –config; CLI overrides environment references then config | JSON result on stdout; diagnostics on stderr | read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |
embed evaluate inspect |
finetuning embed evaluate inspect --config <path> --report <path> [--json] [--quiet] |
–config and –report | required versioned –config; CLI overrides environment references then config | JSON result on stdout; diagnostics on stderr | read-only | offline deterministic implementation; no provider calls, downloads, GPU, or remote mutation | usage/config/schema, unavailable capability, checkpoint/artifact, internal | versioned records/config/spec/events/artifacts reject incompatible majors |