Vaultspec documentation

Vaultspec adds a decision-led development workflow and semantic codebase search to your coding agent.

Install

Install both required components:

1. Install vaultspec-core.

2. Install vaultspec-rag.

3. Start RAG, index the project, and run a search.

Use the workflow

Open your configured coding agent and use one of these prompts:

Use vaultspec-research to investigate adding full-text search to the API. Use the feature tag search-api.

Execute the approved plan for search-api.

Use vaultspec-code-review to review the completed search-api implementation.

The agent pauses for approval before it records the decision and before it executes the plan. Read the operating model for the records and approval points.

Command references

• vaultspec-core CLI reference: every Core command, option, outcome, and exit code.

• vaultspec-rag CLI reference: every RAG command, option, outcome, and exit code.

Advanced

• Core document syntax

• Core MCP tools

• Review and correctness

• RAG query craft

• RAG configuration

• RAG service operation

• RAG automation

• RAG storage maintenance

• RAG preprocessing hooks

Troubleshooting

• Core installation or validation: check the workspace and records.

• Missing or stale results: verify the RAG service and index.

• Installation or GPU failures: RAG installation troubleshooting.