Skip to main content
Four-question wizard that gets VoiceGateway running from a fresh install.

​
Synopsis

voicegw onboard is the recommended first-run command. VoiceGateway is framework-agnostic: it meters the native provider instances you build in your agent (via attach()), so onboarding does not ask for a provider or an API key. It collects your project, storage location, port, and daemon preference, writes the config, optionally registers the daemon, prints the one line to add to your agent, and runs a check.

​
Usage

​
Options

​
The four questions

No provider or key: VoiceGateway never writes a secret to voicegw.yaml. You install your provider plugins in your agent and pass the instances to attach() / guard().

​
Behaviour

  1. Resolves the config path (--config, else the default).
  2. Reads the existing config if present so the wizard merges without clobbering hand-edited keys.
  3. Prompts the questions (or three if a --install-daemon flag was already passed).
  4. Writes the merged config: projects.<name>, top-level default_project, cost_tracking.enabled: true (plus db_path if you set one), and serve.port. No providers: block, no key.
  5. If install_daemon is yes: registers the OS-specific service (launchd / systemd / Scheduled Task) to run voicegw serve -c <config path> against the config just written, and starts the daemon. Re-running onboard replaces any prior registration cleanly.
  6. Prints a summary plus the integration snippet:
    and, for fleet mode, the VOICEGW_COLLECTOR_URL / VOICEGW_API_KEY env vars.
  7. Offers to run voicegw check against the new config (drives one synthetic request and confirms it lands in storage).
Pressing Ctrl+C at any point restores the prior voicegw.yaml (or deletes it if there was none) and exits with code 130.

​
Examples

​
Exit codes

voicegw check | voicegw status | voicegw doctor | voicegw serve | voicegw dashboard