Local Connector
Vela Local Connector is a CLI that connects an OpenAI-compatible endpoint on a customer device or internal network to Vela without a public inbound endpoint. Vela does not connect directly to the local runtime; the connector retrieves jobs through outbound polling.
Install
Section titled “Install”npm install -g @vel4ai/local-connectorvela --helpFor pre-publish repo development, use:
pnpm --filter @vel4ai/local-connector mock:local-llmpnpm --filter @vel4ai/local-connector buildBasic Commands
Section titled “Basic Commands”vela add --local-base-url http://127.0.0.1:1234/v1 --model local/mock=mock-local-llm --label "Laptop mock LLM"vela modelsvela startvela start --detachvela statusvela doctorvela start runs in the foreground. vela start --detach starts the same connector in a background child process, prints the PID, and returns to the shell. --background is also accepted. Detached mode is not an OS service manager; use vela status to confirm that Vela sees the connector online.
Endpoint Requirements
Section titled “Endpoint Requirements”The local endpoint must expose these OpenAI-compatible APIs.
| endpoint | Purpose |
|---|---|
GET /models | Check available local model IDs |
POST /chat/completions | Non-streaming and streaming chat completions |
Model Mapping
Section titled “Model Mapping”--model local/mock=mock-local-llm maps the Vela model ID local/mock to the local endpoint model mock-local-llm. Pass --model multiple times when using multiple models.
Config And Timeouts
Section titled “Config And Timeouts”The CLI stores config in $XDG_CONFIG_HOME/vela/connector.json, or ~/.config/vela/connector.json when XDG_CONFIG_HOME is not set. Use VELA_CONNECTOR_CONFIG=/path/to/connector.json to isolate test config.
| Operation | Timeout |
|---|---|
Local /models health check | 3s |
| Non-streaming response | 120s |
| Streaming first response | 60s |
| Streaming idle gap | 30s |
| Streaming total runtime | 5m |