Skip to main content

Module tui

Module tui 

Source
Expand description

TUI Configuration Wizard for rust_memex

Interactive terminal UI for configuring MCP server and host integrations.

§Wizard Flow

  1. Welcome - Brief introduction
  2. EmbedderSetup - Auto-detect Ollama/MLX + configure providers
  3. MemexSettings - Database path, cache size, etc.
  4. HostSelection - Detect and select MCP hosts
  5. SnippetPreview - Preview config snippets
  6. HealthCheck - Verify embedder connectivity + dimension
  7. DataSetup - Optional directory indexing
  8. Summary - Write config and finish

This module is only available when the cli feature is enabled.

Re-exports§

pub use crate::common::HostFormat;
pub use crate::common::HostKind;

Structs§

DataSetupState
State for the data setup wizard step.
DetectedProvider
Detected embedding provider information.
FanOut
Forwards every event to every child sink.
HealthCheckItem
Individual health check result
HealthCheckResult
Aggregate health check results
HealthChecker
Health checker that performs all validation
HostDetection
IndexTelemetrySnapshot
Pull-friendly indexing telemetry snapshot for the TUI and future tooling.
IndexingJob
Parameters describing what to index and how (data + tuning).
MonitorSnapshot
Latest system monitor snapshot for the dashboard.
TracingSink
Emits tracing logs for indexing events.
TuiTelemetrySink
Updates the latest dashboard snapshot for the TUI.
WizardConfig
Configuration for running the wizard.

Enums§

CheckStatus
Status of an individual health check
DataSetupOption
Data setup option selected by user.
DataSetupSubStep
Sub-steps within data setup.
GpuStatus
GPU probe status for the dashboard.
ImportMode
Mode for importing LanceDB.
IndexControl
Control messages sent from the TUI to the scheduler.
IndexEvent
Events emitted by the indexing scheduler.
ProviderKind
Type of embedding provider.
ProviderStatus
Provider connection status.

Traits§

IndexEventSink
Event sinks must stay synchronous and infallible.

Functions§

check_custom_endpoint
Check a custom endpoint for OpenAI-compatibility.
collect_indexable_files
Collect files from a directory for indexing.
detect_hosts
Detect all known MCP host configurations.
detect_providers
Detect embedding providers on standard ports.
import_lancedb
Import an existing LanceDB database.
run_wizard
Run the TUI wizard.
spawn_monitor
Spawn the system monitor sampler with a latest-value watch channel.
start_indexing
Start the concurrent indexing scheduler.
validate_path
Validate a user-provided path with the repo’s path safety rules.
write_mux_service_config

Type Aliases§

SharedIndexTelemetry
Shared watch sender for the latest telemetry snapshot.