Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Diagnostics and health

veyyon setup status is the health check. It answers two things in one pass: whether the install itself works, and whether you are signed in to a provider. Plugin health has its own command, and the TUI has its own debug tools.

System health

$ veyyon setup status
$ veyyon setup status --json

The install checks run first, because nothing below them can work if the install does not. They are the same checks the installer runs at the end of every install, run against your machine as it is now:

CheckWhat it proves
veyyon on PATHThe shell can find it, and which file it found.
PATH copiesOnly one veyyon is on your PATH. A second one earlier on PATH keeps answering after an update writes the first, which is what makes an update look like it did nothing.
veyyon runsIt executes and reports the version you are running. If it will not start, the check quotes the system error text.
Native addonA real search returns a real match, so the native addon loaded. --version alone passes without it.
Install methodWhether veyyon update swaps the binary or advances a source checkout.
vey aliasThe short name used throughout the documentation resolves.
Shell completionsCompletion files are installed, and for which shells. On Windows that is the single script beside your PowerShell profile, since PowerShell has no directory it autoloads completions from.

None of them touches the network. A health check you cannot run when the network is what broke is not much of a health check.

After the install checks come the credential checks: git on PATH (missing is an error), and provider authentication through OAuth or one of GEMINI_API_KEY / OPENAI_API_KEY / ANTHROPIC_API_KEY / KIMI_API_KEY (missing is a warning).

The command exits non-zero when any check reports an error, so you can gate a script on it. Warnings exit zero: they are worth reading, not worth stopping for.

Plugin doctor

$ veyyon plugin doctor
$ veyyon plugin doctor --fix

Checks plugin installation health. With --fix, it attempts automatic repairs where implemented.

TUI debug

/debug

Opens the debug tools selector in the interactive session.

Memory diagnostics

/memory diagnose
/memory stats

Run diagnostics and statistics on the configured memory backend (memory.backend: mnemopi, hindsight, local) from the TUI. See Memory.

Which one to reach for

  1. veyyon setup status when veyyon itself is misbehaving: it covers the install and your credentials.
  2. veyyon plugin doctor when an extension is misbehaving.
  3. /debug and /memory diagnose inside a session.
  4. Troubleshooting for common setup failures.

Exit status

Both veyyon setup status and veyyon plugin doctor exit non-zero when a check reports an error, and zero when the worst result is a warning.

See also