vaultspec-rag
vaultspec-rag CLI referenceLink to vaultspec-rag CLI reference
Generated from the live command surface. Each entry lists the command’s arguments, options, types, defaults, and help text.
Global options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
directory |
no |
- |
Directory containing .vault and .vaultspec |
|
boolean |
no |
off |
Enable INFO logging |
|
boolean |
no |
off |
Enable DEBUG logging |
|
str |
no |
- |
Index data directory (default: .vault/data/search-data) |
|
str |
no |
- |
Index data subdirectory relative to –data-dir |
|
str |
no |
- |
Directory for service runtime files (default: ~/.vaultspec-rag) |
|
str |
no |
- |
Service log filename inside –status-dir |
|
boolean |
no |
off |
Show version |
|
boolean |
no |
- |
Install completion for the current shell. |
|
boolean |
no |
- |
Show completion for the current shell, to copy it or customize the installation. |
Commands
doctor
list
search
Search project documents or source code by meaning. Uses the running service when available. Local search runs only with an explicit mandate (–allow-fallback or configured local-only mode).
Command
vaultspec-rag search
Arguments
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
yes |
required |
The search query text. |
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
no |
vault |
Search area: vault documentation, source code, extracted documents, or all three with combined. Aliases: docs, codebase, all. |
|
int |
no |
10 |
Maximum number of results to show. Default 10 keeps the output focused. |
|
str |
no |
- |
Only show code results in this programming language. |
|
str |
no |
- |
Only show code results from this one exact project-relative path. Use –include-path to select a subtree or a glob. |
|
str |
no |
- |
Only show code results whose project-relative path matches this pattern. A plain pattern matches that path and everything under it; globs are accepted. Repeatable. |
|
str |
no |
- |
Hide code results whose project-relative path matches this pattern. A plain pattern matches that path and everything under it; globs are accepted. Repeatable. |
|
boolean |
no |
- |
Collapse matching locale files into one representative result. Defaults to the configured value (on) when not specified. |
|
str |
no |
- |
Prefer one kind of code result: production, tests, or documentation. |
|
str |
no |
- |
Only show code results for this source-code structure. |
|
str |
no |
- |
Only show code results from this function or method. |
|
str |
no |
- |
Only show code results from this class or struct. |
|
str |
no |
- |
Only show document results with this type, such as ‘adr’ or ‘plan’. |
|
str |
no |
- |
Only show document results for this feature tag. |
|
str |
no |
- |
Only show document results from this date (yyyy-mm-dd). |
|
str |
no |
- |
Only show document results with this tag, without ‘#’. |
|
str |
no |
- |
Only show extracted-document results from this source path. |
|
str |
no |
- |
Only show document results emitted by this extractor. |
|
str |
no |
- |
Only show document results from this extractor version. |
|
str |
no |
- |
Only show document results with this locator kind. |
|
boolean |
no |
off |
Show numeric relevance scores in human search output. |
|
int |
no |
- |
Service port (defaults to running service). |
|
boolean |
no |
off |
If the selected service is not reachable, run the search locally instead of stopping with an error. |
|
boolean |
no |
off |
Show model loading and progress messages during local search. |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
|
float |
no |
- |
Connection and read timeout budget in seconds for searches handled by the service (default 300 seconds; override with VAULTSPEC_RAG_SEARCH_TIMEOUT). |
|
str |
no |
immediate |
Return immediately or wait within a bounded publication window. |
|
float |
no |
- |
Publication wait bound in seconds; requires –freshness-policy bounded. |
index
Build or update the vault, code, and extracted-document search indexes. Uses the running service, or –borrow-gpu for explicit local GPU work.
Command
vaultspec-rag index
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
no |
all |
What to index: vault, code, document, or combined. Aliases: docs, codebase, all. |
|
str |
no |
- |
Override the embedding model name. |
|
boolean |
no |
off |
Delete the selected index data before rebuilding it. |
|
boolean |
no |
off |
Verify every stored payload against existing canonical proof through the running service; never creates or repairs proof. |
|
int |
no |
- |
Service port (defaults to running service). |
|
boolean |
no |
off |
Show the resolved code/document admission summary without indexing. Use with –type code, document, combined, or the default all alias. |
|
int |
no |
50 |
Maximum source-code file paths to show in human dry-run output. JSON output still includes every path. |
|
str |
no |
- |
Ad-hoc exclusion pattern (repeatable, gitignore syntax). |
|
boolean |
no |
off |
Acquire a borrower lease, pause a compatible running service, then run this index command locally before resuming it. |
|
boolean |
no |
off |
Load no document-preprocessing rules for this in-process index run (VAULTSPEC_RAG_PREPROCESS=off). Applies to in-process indexing only; a running service uses the preprocess mode it was started with. |
|
boolean |
no |
off |
Show model loading and indexing progress messages. |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
clean
Delete selected index data without rebuilding it. Does not load models or use the GPU.
Command
vaultspec-rag clean
Arguments
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
yes |
required |
What to delete: vault, code, document, or combined/all. Required so nothing is deleted by accident. |
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
boolean |
no |
off |
Confirm the destructive wipe without prompting. |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. Requires –yes so no prompt interrupts the JSON output. |
install
Set up vaultspec-rag in a workspace. Creates the required workspace folders, installs bundled rules and integration files, and syncs the files used by supported tools. By default, install also provisions the external dependencies the server-first default needs - the embedding/reranker models and the pinned Qdrant server binary - and ensures the optional MCP extra so the agent-facing MCP search surface can run, and asks before changing PyTorch package configuration. Use –local-only for the minimal local backend (skips the binary), the finer –skip-torch/–skip-models/–skip-qdrant flags for partial opt-out, –no-mcp for a CLI-only workspace without the mcp dependency, and –no-provision to set up the workspace only; use –yes or –no-torch-config for non-interactive runs.
Command
vaultspec-rag install
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
directory |
no |
- |
Workspace path (default: current working directory). |
|
boolean |
no |
off |
Refresh bundled rules and integration files even if present. |
|
boolean |
no |
off |
Preview changes without writing. |
|
boolean |
no |
off |
Override existing files. Also bypasses the torch-config confirmation prompt (implies –yes for that step). –no-torch-config still wins. |
|
str |
no |
() |
Skip a component (repeatable). |
|
choice |
no |
- |
Provisioning mode: ‘tool’ (default, launched via uvx), ‘dependency’ (a runtime project dependency resolved through the project’s own venv, ships in built distributions), or ‘dev’ (the default dev dependency group; renders like dependency but does not ship in built distributions). Auto-detected from pyproject.toml when omitted. |
|
boolean |
no |
on |
Configure the CUDA PyTorch package source in pyproject.toml. –no-torch-config takes precedence over –force / –yes. |
|
boolean |
no |
on |
Check whether a persistent uv tool environment holds a processor-only torch build, and report the command that repairs it. Nothing is installed or replaced by this check. –no-tool-repair skips it entirely. |
|
str |
no |
- |
Place the managed CUDA torch direct-dependency under the PEP 735 [dependency-groups].NAME surface instead of [project].dependencies, so a dev-only consumer does not leak torch into its published requirements. Defaults the group name to ‘dev’ when passed without a value. Omit the flag entirely to keep the historic [project].dependencies placement. The group must be enabled for the resolve ( |
|
boolean |
no |
off |
Skip the PyTorch configuration prompt. Required for non-interactive installs unless –no-torch-config is used. |
|
boolean |
no |
off |
Run |
|
boolean |
no |
on |
Provision external dependencies (models and the Qdrant server binary) after enrollment. On by default; –no-provision sets up the workspace only. |
|
boolean |
no |
on |
Enroll the agent-facing MCP search surface and reconcile its optional dependency at RAG’s existing project placement. On by default; –no-mcp sets up a CLI-only workspace without the mcp dependency (and, on Windows, without pywin32). |
|
boolean |
no |
off |
Use the on-disk store instead of the supervised Qdrant server: skips the Qdrant binary download and persists the local backend so |
|
boolean |
no |
off |
Skip the PyTorch provisioning step (finer than –local-only). |
|
boolean |
no |
off |
Skip the embedding/reranker model provisioning step. |
|
boolean |
no |
off |
Skip the Qdrant server binary provisioning step. |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
uninstall
Remove vaultspec-rag setup from a workspace. Without –force, this only previews what would be removed.
Command
vaultspec-rag uninstall
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
directory |
no |
- |
Workspace path (default: current working directory). |
|
boolean |
no |
off |
Also remove index data under .vault/data/. |
|
boolean |
no |
off |
Preview changes without removing. |
|
boolean |
no |
off |
Required to execute. Uninstall is destructive. |
|
str |
no |
() |
Skip a component (repeatable). |
|
boolean |
no |
off |
Skip confirmation prompts. |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
status
Show project index counts, index data location, and compute device.
Command
vaultspec-rag status
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
server doctor
Report readiness across two axes: installed dependencies (torch, models, qdrant binary) and the live service (a running daemon’s health). A dead daemon is reported as not ready.
Command
vaultspec-rag server doctor
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
boolean |
no |
off |
Emit one structured JSON outcome. It is the readiness snapshot. |
server warmup
Download GPU model files before they are needed. Run once before the first index to avoid model download latency at search time.
Command
vaultspec-rag server warmup
Arguments
None.
Options
None.
server jobs
Show recent index update activity from the running service.
Command
vaultspec-rag server jobs
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
int |
no |
20 |
Maximum number of matching jobs to show. |
|
str |
no |
- |
Filter by job state: active, waiting, finished, failed, or cancelled. |
|
str |
no |
- |
Filter by index type: vault or code. |
|
str |
no |
- |
Filter by who started the job: manual requests or automatic updates. |
|
str |
no |
- |
Filter by text in job id, outcome, or progress. |
|
boolean |
no |
off |
Show only failed jobs. |
|
str |
no |
- |
Show details for a job id or prefix. |
|
float |
no |
- |
Show jobs updated within the last N seconds. |
|
int |
no |
- |
Service port (defaults to running service). |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. Always use this for scripted waits: the human summary line unconditionally contains the words ‘active’ and ‘waiting’. |
|
boolean |
no |
off |
Open the interactive jobs interface with per-job controls. |
|
float |
no |
2.0 |
Seconds between refreshes in the interactive interface. |
server logs
Show grouped raw service and Qdrant logs live or offline.
Command
vaultspec-rag server logs
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
int |
no |
200 |
Maximum recent lines returned per selected source. |
|
choice |
no |
all |
Managed log source: service, qdrant, or all. |
|
str |
no |
- |
Keep lines containing this job ID. |
|
str |
no |
- |
Keep lines containing this text. |
|
int |
no |
- |
Use this live service port before reading retained local logs. |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
server preflight
Observe service quiescence and device capacity without authorizing GPU work.
Command
vaultspec-rag server preflight
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
int |
no |
- |
Service port (defaults to running service). |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
server pause
Hold the running service at safe checkpoints.
Command
vaultspec-rag server pause
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
int |
no |
- |
Service port (defaults to running service). |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
server resume
Release a paused service.
Command
vaultspec-rag server resume
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
int |
no |
- |
Service port (defaults to running service). |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
server status
Show the human operator summary for server readiness, work, and next checks.
Command
vaultspec-rag server status
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
int |
no |
- |
Service port (defaults to running service). |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. Preserves exit codes 0 (running), 3 (stopped), 4 (crashed or divergent), and 5 (warming: models loading, not yet serving). |
|
boolean |
no |
off |
Show process, heartbeat, service identity, model, and extra diagnostic details in the human output. |
server reconcile
Wait for the running service to republish its discovery records. Non-destructive: nothing is written, deleted, stopped, or restarted. Exits 0 once discovery agrees, 1 if it does not converge in time.
Command
vaultspec-rag server reconcile
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
float |
no |
35.0 |
Seconds to wait for convergence before reporting unresolved. |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. Preserves exit codes 0 (converged) and 1 (not converged). |
server start
Start the background search service. Defaults to the managed Qdrant server backend (server mode); pass –local-only for the on-disk store. Waits until it is ready and records how the CLI can reach it.
Command
vaultspec-rag server start
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
int |
no |
8766 |
Port for the background search service. |
|
boolean |
no |
- |
Enable or disable automatic index updates when files change (default: enabled). |
|
int |
no |
- |
Delay before indexing a burst of file changes, in milliseconds. |
|
float |
no |
- |
Minimum wait before automatically updating a project again, in seconds. |
|
boolean |
no |
off |
Use the on-disk local store instead of the default managed Qdrant server. This is the first-class opt-out for CI, offline, and small-project hosts. |
|
boolean |
no |
- |
Explicitly opt in to (or out of) the managed Qdrant server. Server mode is already the default, so –qdrant is redundant; use –local-only to select the on-disk store. Unset leaves the current Qdrant setting unchanged. |
|
boolean |
no |
off |
Download the managed Qdrant server if it is missing. Without this flag, start prints the install command. |
|
boolean |
no |
off |
Kill switch: the service loads no document-preprocessing rules for any root (forwards VAULTSPEC_RAG_PREPROCESS=off). |
|
boolean |
no |
off |
Emit one structured JSON outcome. An already-running owned service is the success |
server stop
Stop the background search service.
Command
vaultspec-rag server stop
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
int |
no |
- |
Stop the service answering on this port, resolving its identity from /health rather than the status file. Use when the service runs on a non-default port or the status file diverges from the running instance. |
|
boolean |
no |
off |
Emit one structured JSON outcome. An already-stopped service is the success |
|
boolean |
no |
off |
Reap surplus vaultspec-rag daemons that lost the machine-singleton race and linger holding no port, lock, or discovery pointer, invisible to a normal stop. Confirm-then-reap, scoped to this singleton’s port; the live singleton, isolated-config, and foreign-worktree daemons are always spared. |
server job show
Show one exact job resource; human output accepts a unique prefix.
Command
vaultspec-rag server job show
Arguments
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
yes |
required |
Exact job id or human-mode prefix. |
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
int |
no |
- |
Service port (defaults to running service). |
|
boolean |
no |
off |
Emit one structured JSON outcome. |
server job pause
Request a cooperative pause for one job.
Command
vaultspec-rag server job pause
Arguments
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
yes |
required |
Exact job id or human-mode prefix. |
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
int |
no |
- |
Service port (defaults to running service). |
|
boolean |
no |
off |
Emit one structured JSON outcome. |
server job resume
Resume one paused job through reconciliation.
Command
vaultspec-rag server job resume
Arguments
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
yes |
required |
Exact job id or human-mode prefix. |
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
int |
no |
- |
Service port (defaults to running service). |
|
boolean |
no |
off |
Emit one structured JSON outcome. |
server job stop
Request cancellation without disabling automatic updates.
Command
vaultspec-rag server job stop
Arguments
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
yes |
required |
Exact job id or human-mode prefix. |
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
int |
no |
- |
Service port (defaults to running service). |
|
boolean |
no |
off |
Emit one structured JSON outcome. |
|
boolean |
no |
off |
Request force termination; currently rejected when unsupported. |
server job retry
Create a linked retry for one retryable terminal job.
Command
vaultspec-rag server job retry
Arguments
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
yes |
required |
Exact job id or human-mode prefix. |
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
int |
no |
- |
Service port (defaults to running service). |
|
boolean |
no |
off |
Emit one structured JSON outcome. |
server job delete
Delete one terminal job from retained history.
Command
vaultspec-rag server job delete
Arguments
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
yes |
required |
Exact job id or human-mode prefix. |
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
int |
no |
- |
Service port (defaults to running service). |
|
boolean |
no |
off |
Emit one structured JSON outcome. |
server projects list
List projects currently loaded by the running search service.
Command
vaultspec-rag server projects list
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
int |
no |
- |
Service port (defaults to running service). |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
server projects unload
Unload a project from the running search service.
Command
vaultspec-rag server projects unload
Arguments
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
yes |
required |
Project to unload. |
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
int |
no |
- |
Service port (defaults to running service). |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
server updates status
Show automatic index update settings and projects.
Command
vaultspec-rag server updates status
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
int |
no |
- |
Service port (defaults to running service). |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
|
str |
no |
- |
Only report controllers for this project root. |
|
str |
no |
- |
Only report this index source. |
|
str |
no |
- |
Only report controllers in this state. |
|
int range |
no |
256 |
Most controllers to report. |
server updates start
Start automatic index updates for a project.
Command
vaultspec-rag server updates start
Arguments
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
yes |
required |
Project to keep indexed. |
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
int |
no |
- |
Service port (defaults to running service). |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
server updates stop
Stop automatic index updates for a project.
Command
vaultspec-rag server updates stop
Arguments
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
yes |
required |
Project to stop updating automatically. |
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
int |
no |
- |
Service port (defaults to running service). |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
server updates timing
Change automatic index update timing.
Command
vaultspec-rag server updates timing
Arguments
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
yes |
required |
Project to update timing for. |
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
int |
no |
- |
Delay before indexing a burst of file changes, in milliseconds. |
|
float |
no |
- |
Minimum wait before automatically updating a project again, in seconds. |
|
int |
no |
- |
Service port (defaults to running service). |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
server qdrant install
Download and verify the managed Qdrant server. If the requested version is already installed, nothing is downloaded.
Command
vaultspec-rag server qdrant install
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
boolean |
no |
off |
Replace an installed Qdrant server when the managed version changed. |
|
boolean |
no |
off |
Preview the version, release package, download, install path, and digest without downloading or writing anything. |
|
path |
no |
- |
Register an operator-supplied Qdrant executable instead of downloading the managed release. |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
server qdrant status
Show the managed Qdrant executable, address, connection, and process.
Command
vaultspec-rag server qdrant status
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
int range |
no |
- |
Qdrant HTTP port to check. |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
server qdrant clean
Delete managed Qdrant server installs. Destructive: requires –yes. –keep-current preserves the current managed version. Index data is never touched.
Command
vaultspec-rag server qdrant clean
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
boolean |
no |
off |
Preserve the current managed Qdrant version. |
|
boolean |
no |
off |
Confirm deletion of managed Qdrant installs. |
|
boolean |
no |
off |
Preview what would be removed. |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
server qdrant quarantine
Move a corrupt collection out of the shared store so the server can start again. Run with no name to list collections; name one to quarantine it (requires –yes). The quarantined collection re-indexes on its next use; nothing is deleted.
Command
vaultspec-rag server qdrant quarantine
Arguments
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
no |
- |
Collection to quarantine; omit to list the store. |
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
boolean |
no |
off |
Confirm moving the named collection aside. |
|
boolean |
no |
off |
Preview the move without touching the store. |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
server storage survey
List stored RAG namespaces classified as live, orphaned, or unknown; –root looks up one root’s collection prefix and namespace.
Command
vaultspec-rag server storage survey
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
|
boolean |
no |
off |
Show only orphaned namespaces (prune candidates). |
|
boolean |
no |
off |
Show only unattributable (unknown) namespaces. |
|
str |
no |
- |
Narrow to one root’s namespace and report its authoritative collection prefix (works even for a root not yet indexed). |
|
boolean |
no |
off |
Force the service to recompute the survey instead of answering from its cached snapshot (slower; walks every namespace). |
server storage delete
Delete one named RAG namespace, addressed by its r{hash}_ prefix or by –root (the sanctioned per-root teardown for harnesses).
Command
vaultspec-rag server storage delete
Arguments
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
no |
- |
The namespace prefix to delete (r{hash}_). |
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
no |
- |
Address the namespace by its source root path instead of the prefix; an already-absent namespace is a success (exit 0). |
|
boolean |
no |
off |
Apply the deletion. |
|
boolean |
no |
off |
Preview without deleting. |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
|
boolean |
no |
off |
Permit deleting a prefix the manifest cannot attribute (dangerous). |
server storage prune
Reclaim every orphaned RAG namespace (source root gone).
Command
vaultspec-rag server storage prune
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
boolean |
no |
off |
Apply the prune. |
|
boolean |
no |
off |
Preview without deleting. |
|
boolean |
no |
off |
Also remove config-less collection dirs left behind by crashes (unloadable by the server; filesystem delete). |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
server storage reconcile
Shrink existing collections to the bounded segment geometry.
Command
vaultspec-rag server storage reconcile
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
boolean |
no |
off |
Apply the reconcile. |
|
boolean |
no |
off |
Preview without changing. |
|
int |
no |
0 |
Max collections to reconcile (0 = every drifted collection). |
|
boolean |
no |
on |
Wait for the optimizer to converge before reporting. With –no-wait the updates are issued and reclamation is reported by a later run, since mid-flight sizes are meaningless. |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
server storage migrate
Migrate a root’s index between local and server backends.
Command
vaultspec-rag server storage migrate
Arguments
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
yes |
required |
The workspace root whose index to migrate. |
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
yes |
required |
Target backend: ‘server’ or ‘local’. |
|
boolean |
no |
off |
Apply the migration. |
|
boolean |
no |
off |
Preview without copying. |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
server storage restore
Restore an archived namespace into a named destination root. The destination must hold no collections; there is no override. Applying a restore needs a non-Windows Qdrant server. Previewing the destination with –dry-run works on any platform.
Command
vaultspec-rag server storage restore
Arguments
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
yes |
required |
Path to the archive directory holding the snapshot manifest. |
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
yes |
required |
Destination root path the restored namespace is keyed to. |
|
boolean |
no |
off |
Apply the restore. |
|
boolean |
no |
off |
Preview the destination collections without writing. |
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
preprocess list
List resolved preprocess rules for the project.
Command
vaultspec-rag preprocess list
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
preprocess check
Validate .vaultragpreprocess.toml and report configuration problems.
Command
vaultspec-rag preprocess check
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
preprocess run-one
Run the matching rule against one file (no indexing).
Command
vaultspec-rag preprocess run-one
Arguments
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
str |
yes |
required |
Source file to preprocess. |
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |
preprocess status
Report the preprocess mode, config presence, and rule count.
Command
vaultspec-rag preprocess status
Arguments
None.
Options
Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
boolean |
no |
off |
Emit JSON for scripts instead of human text. |