Markdown source

Command Reference

This page lists all 21 commands shown by mdvdb --help. Click a command name for its full reference page with options, examples, and JSON output format.

All Commands

CommandDescription
mdvdb searchSemantic search across indexed markdown files
mdvdb ingestIngest markdown files into the index
mdvdb statusShow index status and configuration
mdvdb infoShow collection or folder stats and a reindex estimate
mdvdb schemaShow inferred metadata schema
mdvdb clustersInspect automatic communities and manage Collection or Shard Topics
mdvdb shardsManage named recursive folder scopes
mdvdb treeShow file tree with sync status indicators
mdvdb getGet metadata for a specific file
mdvdb collectionQuery a folder as frontmatter rows and columns (list alias)
mdvdb watchWatch for file changes and re-index automatically
mdvdb modulesInspect and run computed-field modules
mdvdb initInitialize a new .markdownvdb config file
mdvdb configShow resolved configuration
mdvdb embeddingDiscover provider models and probe dimensions
mdvdb doctorRun diagnostic checks on config, provider, and index
mdvdb linksShow links originating from a file
mdvdb backlinksShow backlinks pointing to a file
mdvdb orphansFind orphan files with no links
mdvdb edgesShow semantic edges between linked files
mdvdb graphShow Collection- or Shard-native graph analysis for visualization

Commands by Category

Core Workflow

These commands form the primary usage loop. See Search Modes for how search works, Embedding Providers for provider setup, and Chunking for how files are split.

CommandPurpose
searchFind relevant content using semantic, lexical, or hybrid search
ingestIndex markdown files (supports incremental and full re-indexing)
statusCheck how many files, chunks, and vectors are in the index
collectionQuery a folder as a filterable and pageable frontmatter table

Setup & Configuration

See Configuration for the full environment variable and config file reference.

CommandPurpose
initCreate a .markdownvdb config file (project or global)
configDisplay the fully resolved configuration with all values
embeddingDiscover models and verify provider dimensions with a live probe
shardsCreate and manage project-local named folder scopes
doctorDiagnose issues with config, embedding provider, and index

Data Inspection

See Clustering for how clusters are computed and Index Storage for how data is stored.

CommandPurpose
schemaView auto-inferred frontmatter metadata schema
infoView scoped file, chunk, vector, sync, and reindex statistics
clustersView automatic communities or manage independent scoped Topics
treeView file tree with per-file sync status (New/Modified/Synced/Deleted)
getRetrieve metadata and frontmatter for a single file

See Link Graph for how links are extracted and the graph is built.

CommandPurpose
linksShow outgoing links from a file (with multi-hop traversal)
backlinksShow files that link to a given file
orphansFind files with no incoming or outgoing links
edgesShow semantic edges (relationship labels) between linked files
graphExport Collection or Shard-local graph analysis

Automation

See Ignore Files for how the watcher determines which files to monitor.

CommandPurpose
watchMonitor filesystem for changes and re-index automatically
modulesValidate, recompute, and inspect Formula/Lookup/Rollup data

Hidden Commands

The following commands are available but hidden from --help output:

CommandDescription
mdvdb completions <shell>Generate shell completions (see Shell Completions)
mdvdb chunks <dir>Dump chunks as JSON for benchmarking (internal use)

Global Options

Every subcommand accepts the first four global flags below. --version is a top-level flag and must be used as mdvdb --version. See Global Options for details.

FlagShortDescription
--verbose-vIncrease log verbosity (-v info, -vv debug, -vvv trace)
--root <PATH>Project root directory (defaults to current directory)
--no-colorDisable colored output
--jsonOutput results as JSON
--versionPrint version information with logo (top level only)

See Also