KivaDB Runner

Run KivaDB command files (.kva) from VS Code, by FomaDev.

KivaDB is a typed key-value, document and vector database in a single executable. This extension runs your .kva files with kivadb run, shows what KivaDB answers as it answers, and marks the command that failed.

Requirements

The kivadb executable, version 1.5 or later (install it). If it is not in your PATH, set kivadb.runner.executable to its full path.

For colours and snippets in .kva files, install KivaDB Language (fomadev.kiva-kva) too.

Usage

Action	How
Run the whole file	▶ in the editor title, Ctrl+Alt+R (Cmd+Alt+R on macOS), right-click → KivaDB: Run Script, or right-click a `.kva` file in the explorer
Run the selected lines, or the line of the cursor	Ctrl+Alt+Enter, or right-click → KivaDB: Run Selected Lines
Stop a script	Click the status bar item, or KivaDB: Stop the Running Script

The KivaDB Runner output channel shows the command line (password hidden), every line KivaDB prints, and the result:

▶ kivadb run C:\shop\init.kva
OK: parametre:devise saved.
C:\shop\init.kva:12: Error: String values like 'oups' must be quoted ("" or '').
C:\shop\init.kva: stopped at line 12 (5 of 9 commands run).
✖ kivadb ended with exit code 1 (0.08 s)

The failing command is underlined in the editor and listed in the Problems view; it disappears as soon as you edit the file.

Settings

Setting	Default	Effect
`kivadb.runner.executable`	`kivadb`	The executable, or its full path
`kivadb.runner.home`		KivaDB home directory (`--home`); empty: the default one, or the server already running
`kivadb.runner.connect`		A remote server, `host:port` (`--connect`)
`kivadb.runner.tls`	`false`	Encrypt that connection (`--tls`)
`kivadb.runner.tlsFingerprint`		The server certificate's SHA-256, shown by `kivadb tls` (`--tls-fingerprint`)
`kivadb.runner.user`		Log in as this user (`-u`)
`kivadb.runner.workspace`		Workspace to run the file in (`-w`)
`kivadb.runner.keepGoing`	`false`	Run the rest of the file after a failing command (`--keep-going`)
`kivadb.runner.saveBeforeRun`	`true`	Save the file before running it
`kivadb.runner.clearOutput`	`true`	Clear the output before each run

Passwords. With a user, the extension asks for the password the first time and can keep it in VS Code's secret storage (the system keychain), never in the settings. KivaDB: Set the Runner Password and KivaDB: Forget the Runner Password change it. It is given to kivadb with -p.

Development

npm install
npm test          # compiles and tests the command line and output parsing
npx vsce package  # builds kiva-runner-<version>.vsix

Press F5 in VS Code to try the extension in a new window.

Releasing. Add a ## <version> section to CHANGELOG.md, set the same version in package.json, commit, then:

git tag v1.0.0
git push origin v1.0.0

The Release workflow tests the extension, packages it and publishes a GitHub release with the .vsix and the notes of that version. Publishing on the Marketplace is manual: download the .vsix from the release, then upload it at https://marketplace.visualstudio.com/manage/publishers/fomadev.

License

Fordima Public License (FPL).