Skip to main content

Commands

Enum Commands 

Source
pub enum Commands {
    Demo {
        query: String,
        top_k: usize,
    },
    Index {
Show 15 fields path: String, output: String, chunk_size: usize, chunk_overlap: usize, dimension: usize, embedder: EmbedderType, model: SemanticModel, recursive: bool, chunk_strategy: ChunkStrategy, jobs: usize, manifest: bool, exclude: Vec<String>, dedup: bool, sqlite: bool, incremental: bool,
}, Query { query: String, index: String, top_k: usize, format: String, mode: String, fusion: String, fusion_k: Option<f32>, candidates: usize, rerank: String, hyde: bool, }, Transcribe { path: String, recursive: bool, skip_existing: bool, jobs: usize, model: Option<String>, backend: BackendType, dry_run: bool, prompt: Option<String>, hotwords: Option<String>, exclude: Vec<String>, }, ExtractFrames { path: String, recursive: bool, threshold: f64, min_interval: f64, jobs: usize, skip_existing: bool, dry_run: bool, exclude: Vec<String>, }, Info, }
Expand description

Every command the Trueno-RAG CLI offers.

Clone so apr rag can hand an already-parsed command to dispatch without re-parsing argv.

Variants§

§

Demo

Run a demo RAG query

Fields

§query: String

Query string

§top_k: usize

Number of results to return

§

Index

Index documents from a file or directory

Fields

§path: String

Path to document(s)

§output: String

Output directory for index

§chunk_size: usize

Chunk size in characters (for recursive chunker)

§chunk_overlap: usize

Chunk overlap in characters (for recursive chunker)

§dimension: usize

Embedding dimension (only for tfidf embedder)

§embedder: EmbedderType

Embedder type (tfidf or semantic)

§model: SemanticModel

Model for semantic embeddings (mini-lm, bge-small, bge-base)

§recursive: bool

Recursively scan subdirectories

§chunk_strategy: ChunkStrategy

Chunking strategy (auto, recursive, timestamp)

§jobs: usize

Number of parallel loading jobs

§manifest: bool

Write a JSON manifest of indexed files and chunks

§exclude: Vec<String>

Glob patterns to exclude files/directories (repeatable)

§dedup: bool

Deduplicate chunks with identical content (keeps first occurrence)

§sqlite: bool

Also export a SQLite+FTS5 index (requires sqlite feature)

§incremental: bool

Incremental mode: only re-index changed files (requires –sqlite)

§

Query

Query the RAG pipeline

Fields

§query: String

Query string

§index: String

Path to index directory

§top_k: usize

Number of results

§format: String

Output format (text, json)

§mode: String

Retrieval mode: dense, sparse (BM25), hybrid (BM25 + dense RRF)

§fusion: String

Fusion strategy (hybrid mode only): rrf, linear, dbsf

§fusion_k: Option<f32>

Fusion parameter: RRF k value or Linear dense_weight

§candidates: usize

Candidates per source for hybrid retrieval

§rerank: String

Reranking strategy: none, lexical

§hyde: bool

Enable HyDE (Hypothetical Document Embeddings) query expansion. Generates a hypothetical answer via Claude API and uses it for retrieval. Requires ANTHROPIC_API_KEY environment variable and –features eval.

§

Transcribe

Batch transcribe media files to .srt sidecars

Fields

§path: String

Path to directory containing media files

§recursive: bool

Recursively scan subdirectories

§skip_existing: bool

Skip files that already have .srt/.vtt sidecars

§jobs: usize

Number of parallel transcription jobs (CPU mode)

§model: Option<String>

Path to Whisper .apr model file (e.g. base.apr, large-v3-turbo.apr)

§backend: BackendType

Compute backend (cpu, gpu, cuda)

§dry_run: bool

Only report what would be transcribed (dry run)

§prompt: Option<String>

Initial prompt to condition decoder vocabulary (e.g. “AWS, Kubernetes, YAML”)

§hotwords: Option<String>

Path to file with hotwords (one per line) to boost during decoding

§exclude: Vec<String>

Glob patterns to exclude files/directories (repeatable)

§

ExtractFrames

Extract keyframes from video files at scene changes (requires ffmpeg)

Fields

§path: String

Path to directory containing video files

§recursive: bool

Recursively scan subdirectories

§threshold: f64

Scene change detection threshold (0.0-1.0, lower = more frames)

§min_interval: f64

Minimum seconds between extracted frames

§jobs: usize

Number of parallel extraction jobs

§skip_existing: bool

Skip videos that already have frames/ directory

§dry_run: bool

Only report what would be extracted (dry run)

§exclude: Vec<String>

Glob patterns to exclude files/directories (repeatable)

§

Info

Show pipeline info

Trait Implementations§

Source§

impl Clone for Commands

Source§

fn clone(&self) -> Commands

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Commands

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl FromArgMatches for Commands

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

impl Subcommand for Commands

Source§

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.