vaultspec nevenincs
Use this command to install vaultspec with WinGet:
winget install --id=nevenincs.vaultspec -e Unified dashboard UI for the vaultspec ecosystem
Loading...
README
vaultspec-dashboard
The human-facing visual workspace for a Vaultspec project.
Browse feature records, source files, and Git history in a local web interface. Choose a project and worktree, follow relationships in the graph, and read or edit vault Markdown alongside your code.
Getting started · Capabilities · Visual tour · Vaultspec family · Documentation · Status
Getting started
Prerequisites and installation
Supported platforms:
- macOS on Apple silicon
- Linux on arm64, glibc 2.28 or newer
- Linux on x64, glibc 2.28 or newer
- Windows on x64
Intel Macs aren't supported. Use Bash on macOS and Linux, or PowerShell 5.1 or newer on Windows.
The installers download the latest release,
check the archive's SHA-256 checksum, and run vaultspec verify-release on the
installed files.
On macOS or Linux:
curl -fsSL https://github.com/nevenincs/vaultspec-dashboard/releases/latest/download/install.sh | bash
On Windows:
& ([scriptblock]::Create((irm https://github.com/nevenincs/vaultspec-dashboard/releases/latest/download/install.ps1)))
The scripts don't change PATH. To run vaultspec by name in the current
terminal, add its binary directory.
On macOS or Linux:
export PATH="$HOME/.local/share/vaultspec/bin:$PATH"
On Windows:
Set-Item Env:Path "$env:LOCALAPPDATA\Programs\vaultspec\bin;$env:Path"
Repeat this step in each new terminal. Confirm the installation:
vaultspec --version
cargo install and cargo binstall aren't supported: they don't install all
required runtime files.
Release binaries are unsigned. Your operating system may warn before running them.
Agent-to-agent orchestration isn't available in v0.1.12.
Prepare a project
Use a Git repository. Vault validation and authoring require vaultspec-core 0.1.34 or later, installed separately:
uv tool install 'vaultspec-core>=0.1.34'
From the repository root, create the vault structure if the project does not already use Vaultspec:
vaultspec-core install core
This writes the vault structure and project policy. For coding-agent setup too, follow the core installation guide. Inspect the project's records with:
vaultspec-core status
A new vault has no records. Start a feature to create some, or open an existing project's vault for the walkthrough below.
Start the dashboard
From your Git worktree, run:
vaultspec serve
Open the browser URL printed in the terminal. Leave that terminal open while using the dashboard.
Follow one record from your vault to search.
Optional semantic search
Install vaultspec-rag, then start its service and index your repository. The RAG guide lists the supported GPUs, Python versions, and installation routes.
The dashboard connects to the machine-wide RAG service. Wait for indexing to finish before searching by meaning. Stopping that service also affects its other clients.
Without RAG, search still matches document titles and file names. Browsing, the graph, and Git history remain available.
Follow one record from vault to search
- Select your project and worktree in the location selector.
- Expand Vault > Documents > Decisions and select a record. The graph highlights the same selection.
- Double-click the record, or press Enter, to open its title, properties, and Markdown body in the reader. Edit appears when authoring is available.
- Open Search documents and code with Command+Option+S on macOS or Ctrl+Alt+S on Windows and Linux. These are the default bindings; use your configured shortcut if you changed them.
- Choose Docs, enter part of the record's title, and press Enter on a result to open it.
Manage installation
Updating
In v0.1.12, vaultspec update doesn't download a newer release. The installers
also refuse to overwrite an existing installation. These commands don't provide
an in-place upgrade. Consult the target version's
release notes
for upgrade instructions.
Uninstall
The installation commands don't save the scripts. Download install.sh or install.ps1, then run the saved script from its directory.
On macOS or Linux:
bash ./install.sh --uninstall
On Windows:
.\install.ps1 -Uninstall
For a custom installation, pass its directory with --install-dir or
-InstallDir. If removal is refused, the script leaves the installation in place.
The script doesn't delete your project files or per-user application data.
Capabilities
- Browse registered projects and worktrees, then open a project's
.vault/feature records or code. - Explore separate vault and code graph views in desktop layouts. Compact and mobile layouts omit the graph.
- Read source files in read-only views. Edit vault Markdown through Core.
- Search documents and code, with optional semantic search through RAG.
- Track plans, commits, issues, and pull requests.
When a capability is unavailable
Views report unavailable data sources. If Core is missing, prepare a project. For missing RAG, follow optional semantic search.
Visual tour
Open a document from Documents > Decisions without losing its workspace and graph context.
Search documents and code with a real query, scoped result controls, and populated results.
Review current open plans and search-service state from the running workspace.
Vaultspec family
- vaultspec-core: Decision-driven harness for coding agents, and humans.
- vaultspec-rag: The semantic search component for vault and code.
- vaultspec-a2a: Headless agent-to-agent orchestration for Vaultspec.
Documentation
- Follow the feature workflow.
- Check your Core setup.
- Search and index with RAG.
- Troubleshoot the RAG service.
- Read the release notes.
Status and license
Dashboard is in beta. Report bugs or request features.
For bug reports, include the output of vaultspec --version, your OS, installation
method, steps to reproduce, and the relevant error or screenshot.
When relevant, add the command, working directory, selected worktree or --scope,
and vaultspec --json status output. Include RAG health information for semantic
search problems.
Redact credentials, private paths, and private content before posting.
Licensed under MIT.
Contributing
See the contributor guide to build from source, run tests, work on the design, prepare releases, or update screenshots.