mdvdb status
Show whole-index counts, storage size, the embedding configuration recorded in the index, and whether the configured embedding space is compatible with that index.
Usage
mdvdb status [OPTIONS]
Options
This command has no command-specific options. Only global options apply.
Global Options
These options apply to all commands. See Commands Index for details.
| Flag | Short | Description |
|---|---|---|
--verbose | -v | Increase log verbosity (-v info, -vv debug, -vvv trace) |
--root | Project root directory (defaults to current directory) | |
--no-color | Disable colored output | |
--json | Output results as JSON |
Human-Readable Output
When run without --json, status displays a formatted summary:
● Index Status
Documents: 57
Chunks: 342
Vectors: 367
Edges: 25
File size: 12.4 MB
Updated: 3 minutes ago
Embedding: OpenAI
Model: text-embedding-3-small
Dimensions: 1536
Compatibility: Ready
Output Fields
| Field | Description |
|---|---|
| Documents | Number of unique markdown files in the index |
| Chunks | Total number of text chunks across all files |
| Vectors | Total HNSW vectors: document chunks plus semantic-edge vectors |
| Edges | Number of semantic-edge vectors stored in HNSW |
| File size | Size of the index file on disk (human-readable) |
| Updated | Time since the index was last saved (relative format) |
| Embedding | Name of the configured embedding provider |
| Model | Embedding model identifier |
| Dimensions | Vector dimensionality |
| Compatibility | Whether semantic operations can use the current configuration or require a reindex |
Examples
# Show index status
mdvdb status
# Show status as JSON
mdvdb status --json
# Show status for a specific project
mdvdb status --root /path/to/project
JSON Output
IndexStatus (--json)
{
"document_count": 57,
"chunk_count": 342,
"vector_count": 367,
"edge_count": 25,
"last_updated": 1710856200,
"file_size": 13021184,
"embedding_config": {
"provider": "OpenAI",
"model": "text-embedding-3-small",
"dimensions": 1536
},
"embedding_compatible": true,
"reindex_required": false
}
IndexStatus Fields
| Field | Type | Description |
|---|---|---|
document_count | number | Number of unique markdown files in the index |
chunk_count | number | Total number of chunks across all files |
vector_count | number | Total number of vectors in the HNSW index |
edge_count | number | Semantic-edge vectors included in vector_count |
last_updated | number | Unix timestamp (seconds since epoch) of last index save |
file_size | number | Size of the index file on disk in bytes |
embedding_config | EmbeddingConfig | Embedding configuration snapshot |
embedding_compatible | boolean | Whether the runtime configuration matches the stored embedding space |
reindex_required | boolean | Whether semantic search and incremental ingest require mdvdb ingest --reindex |
embedding_compatibility_error | string? | Actionable mismatch reason; omitted when compatible |
EmbeddingConfig Fields
| Field | Type | Description |
|---|---|---|
provider | string | Provider name recorded when the index was created |
model | string | Model identifier (e.g., "text-embedding-3-small") |
dimensions | number | Vector dimensionality (e.g., 1536) |
Notes
- The
statuscommand opens the index in read-only mode. It never modifies the index. - If no index exists (
.markdownvdb/indexnot found), the command reports zero counts. - A healthy index satisfies
vector_count == chunk_count + edge_count. - A provider, model, dimension, endpoint, purpose, normalization, or codec mismatch sets
reindex_required. Lexical and metadata operations remain available while semantic operations wait for a successfulmdvdb ingest --reindex. - The
last_updatedfield is a Unix timestamp in JSON mode, but displayed as a relative time string (e.g., “3 minutes ago”) in human-readable mode. - The
file_sizefield is raw bytes in JSON mode, but displayed in human-readable format (e.g., “12.4 MB”) in human-readable mode.
Related Commands
mdvdb ingest— Index files to populate the indexmdvdb schema— View the inferred metadata schemamdvdb tree— View file tree with sync status indicatorsmdvdb doctor— Run diagnostic checks on the indexmdvdb config— View resolved configuration
See Also
- Index Storage — Index file format and
.markdownvdb/directory - Embedding Providers — Configure supported local and cloud providers
- JSON Output Reference — Complete JSON schema reference
- Configuration — All environment variables and config options
Tesseract