nia-vault

A CLI application for querying your local notes and files using AI-powered semantic search via Nia.

Features

- Semantic Search: Query your notes using natural language
- Multiple Folders: Search across multiple synced folders
- Seamless Integration: Automatically uses credentials from nia-sync
- Flexible Sync: Sync folders on-demand or before searches

Prerequisites

- Node.js >= 18.0.0 or Bun
- nia-sync >= 2.0.0 installed and configured

``bash


Install nia-sync

pip install nia-sync

Authenticate with Nia

nia login

Add folders to sync

nia add ~/Documents/notes
nia start
`

Installation

`bash


With Bun (recommended)

bun install -g nia-vault

With npm

npm install -g nia-vault

With pnpm

pnpm install -g nia-vault
`

After installation, the vault command is available globally.

Quick Start

`bash


Initialize nia-vault (select which folders to search)

vault init

Ask a question

vault ask "Summerize meeting notes from last week"
vault ask "What are my notes about project planning?"

Find files and open in your editor

vault find "meeting notes from last week"
`

Commands

$3

Interactive setup wizard that detects your nia-sync configuration and lets you select which folders to include in searches.

$3

Query your notes using semantic search.

Options:

| Flag | Description |
| ------------------- | ---------------------------------------------------------- |
| -f, --folder | Search specific folder only |
| -s, --sync | Sync folders before searching |
| -p, --plain | Disable terminal markdown rendering (outputs raw markdown) |
| --no-stream | Disable streaming (wait for full response) |

$3

Search for files matching your query and open the selected file in your editor.

`bash
vault find "meeting notes from last week"
`

This command:

1. Searches your indexed folders for files matching the query
2. Displays an interactive file picker
3. Opens the selected file in your default editor ($VISUAL or $EDITOR, falling back to vi)

$3

Manually trigger a sync of all folders.

$3

List, add, or remove folders from search scope.

$3

View or reset configuration.

Configuration

$3

nia-vault reads the API key from ~/.nia-sync/config.json. This file is managed by nia-sync.

$3

Location: ~/.config/nia-vault/config.json

`json
{
"selectedFolders": ["folder-id-1", "folder-id-2"]
}
`

This file only stores which folders are included in searches. The API key is always read from nia-sync.

Troubleshooting

| Error | Solution |
| ------------------------- | -------------------------------------------------- |
| nia-sync not configured | Run nia login to authenticate |
| No configuration found | Run vault init to set up |
| Invalid API key | Run nia login to re-authenticate |
| No synced folders found | Run nia add ~/path to add folders |
| No folders selected | Run vault folders to select folders |
| Editor not found | Set $EDITOR or $VISUAL environment variable |
| No matching files found | Try a different query or ensure folders are synced |

Contributing

$3

When making changes that should be included in a release, please add a changeset:

`bash
bun changeset
`

This will prompt you to describe your changes. Choose the appropriate version bump:

- patch (0.0.x): Bug fixes, small improvements, documentation updates
- minor (0.x.0): New features, non-breaking changes
- major (x.0.0): Breaking changes

The changeset file should be committed with your PR.

$3

`bash


Clone the repository

git clone https://github.com/chenxin-yan/nia-vault.git
cd nia-vault

Install dependencies

bun install

Run in development mode

bun run dev

Build the project

bun run build
``

License

MIT