Use the nv command-line tool

In NeuralVault 2.0 the installer adds a Start menu shortcut that opens a command prompt with the nv tool ready; running a turn from a script needs the Personal edition, while "nv status" and "nv doctor" run on every edition.

Last checked against the app on · View as Markdown

Steps

  1. Open the Start menu and choose "NeuralVault CLI". It opens a command prompt in the folder that holds nv.exe and runs "nv --help". Installation does not add nv to your PATH, so use this shortcut, or run the command from that folder.
  2. Run "nv status". It prints what the install is set to: version, plan, whether the plan includes the CLI, the vault it would open, the model and provider, whether a key is on file, and today’s tokens. It runs nothing and writes nothing.
  3. Run "nv doctor" to check that what "nv run" needs actually works. Each check ends ok, warn or fail, and a fail says what to do about it.
  4. Run a turn with nv run followed by your prompt in quotes. The answer goes to standard output and progress goes to standard error. Add "--output-format json" for one result document, or "--timeout 2m" to stop a run that takes too long.
  5. Scripts can branch on the exit code. 0 means success, 2 means a bad invocation, and 3 means a setting must change before the task can run, such as no key or no vault.

How to tell it worked

"nv status" prints the plan and vault, and "nv run" with a short prompt prints an answer.

If it does not work

"nv" is not recognised as a command.
It is not on your PATH. Use the "NeuralVault CLI" Start menu shortcut, which starts in the right folder.
nv refuses to run a turn on a Free install.
The CLI itself is a Personal-edition feature. "nv status" and "nv doctor" still run on every edition, precisely so they can say why.
nv exits with code 3.
A setting must change first: no provider, no key, or a vault that cannot open. Run "nv doctor", which names the next step.
You attached an image with --file.
The headless engine has no image path, so an image is refused rather than dropped. Attach plain text files only.