QVAC Logo

CLI

QVAC CLI provides tools and an HTTP server that exposes an OpenAI-compatible API.

Overview

QVAC CLI is provided through the @qvac/cli npm package. The CLI itself is installed globally so the qvac command is available on your PATH; @qvac/sdk is installed in your project so the CLI can resolve and run it. At the moment, it provides the following functionality:

  • OpenAI-compatible HTTP server
  • SDK bundling
  • System requirements check

Usage

Install the CLI globally so the qvac command is available on your PATH:

npm install -g @qvac/cli

Install the SDK as a dependency of the project where you'll run the CLI:

npm install @qvac/sdk

See Installation for environment-specific instructions of the SDK.

Create a qvac.config.* file in the root of your project and add the configuration required for the functionality you want to use. See Configuration to learn how to do this.

Run a command:

qvac --help

Tip: if you cannot install the CLI globally, you can run it with npx instead:

npx --package "@qvac/cli" qvac --help

OpenAI-compatible HTTP server

QVAC CLI provides an HTTP server that is compatible with the OpenAI REST API, enabling broad integration with the AI ecosystem. It internally translates HTTP requests into SDK calls. As a result, any system compatible with the OpenAI REST API can point to http://localhost:11434/v1/ and work without changes.

HTTP server

Learn how to run a local HTTP server that exposes an OpenAI-compatible API.

SDK bundling

The qvac bundle sdk command allows you to select only the plugins you need in your project and reduce your application's final bundle size. See Plugin system to learn how to use it.

System requirements check

The qvac doctor command validates that the current host can run @qvac/sdk and @qvac/cli before you hit runtime errors. It prints a human-readable report by default and exits 1 when any required check fails.

System requirements

Full host matrix, deploy targets, optional tools, exit codes, and JSON schema.

Reference

Run qvac --help to see all available commands and qvac <command> --help for command-specific options.

qvac bundle sdk

Generate a tree-shaken Bare worker bundle with selected plugins.

OptionDescription
-c, --config <path>Config file path (default: auto-detect qvac.config.*)
--sdk-path <path>Path to SDK package (default: auto-detect in node_modules)
--host <target>Target host (repeatable)
--defer <module>Defer a module (repeatable)
-q, --quietMinimal output
-v, --verboseDetailed output

qvac serve openai

Start an OpenAI-compatible REST API server.

OptionDescription
-c, --config <path>Config file path (default: auto-detect qvac.config.*)
-p, --port <number>Port to listen on (default: 11434)
-H, --host <address>Host to bind to (default: 127.0.0.1)
--model <alias>Model alias to preload (repeatable, must be in config)
--api-key <key>Require Bearer token authentication
--corsEnable CORS headers
-v, --verboseDetailed output

qvac doctor

Run a preflight check of host system requirements.

OptionDescription
--jsonEmit a machine-readable DoctorReport JSON.
-q, --quietSet the exit code only; suppress human-readable output.

On this page