# Vaultspec

> Vaultspec is a coding harness: it implements a structured coding workflow focused on #features, decision records and the documents grounding them. It bundles rules, agents, skills, and tools to author the documents that describe and track a feature's development.

Actively developed. MIT licensed.

## The harness

- [vaultspec-core](https://github.com/nevenincs/vaultspec-core):
  Decision-driven harness for coding agents, and humans.
- [vaultspec-rag](https://github.com/nevenincs/vaultspec-rag):
  The semantic search component for vault and code. Indexing and search require an
  NVIDIA GPU with CUDA on Linux or Windows, or Apple silicon with MPS. CPU-only and
  AMD inference are not supported.

## Get started

- [Install vaultspec-core](https://vaultspec.neve.md/docs/core/installation.html)
- [Install vaultspec-rag](https://vaultspec.neve.md/docs/rag/installation.html)
- [Start RAG, index the project, and run a search](https://vaultspec.neve.md/docs/rag/getting-started.html)
- [Run a feature with your coding agent](https://vaultspec.neve.md/docs/guides/workflow.html)

## Interfaces

Records are Markdown files in your repository; open them in an editor or Obsidian.

[vaultspec-dashboard](https://github.com/nevenincs/vaultspec-dashboard) is a separate
project building a dedicated frontend on the same files. It is in early development, in
the open.

## Docs

[Download the site-authored guides](https://vaultspec.neve.md/llms-full.txt) as one text file.
Imported manuals remain on the documentation site with source and compatibility notices.

- [Documentation home](https://vaultspec.neve.md/docs/)
- [Concepts](https://vaultspec.neve.md/docs/concepts.html)
- [CLI guide](https://vaultspec.neve.md/docs/guides/cli.html)
- [MCP guide](https://vaultspec.neve.md/docs/guides/mcp.html)
- [Semantic search quickstart](https://vaultspec.neve.md/docs/rag/getting-started.html)
- [Core documentation](https://vaultspec.neve.md/docs/core/index.html)
- [RAG documentation](https://vaultspec.neve.md/docs/rag/index.html)
- [vaultspec-core on PyPI](https://pypi.org/project/vaultspec-core/)
- [vaultspec-rag on PyPI](https://pypi.org/project/vaultspec-rag/)