Capabilities Reference
Declare capabilities in veloxkit.config.ts under capabilities: [].
| Capability | APIs unlocked | Notes |
|---|---|---|
fs | velox.fs — read, write, watch, stat files and directories | — |
db | velox.db — SQLite queries, migrations, vector search | — |
network | velox.network — fetch, WebSocket, mDNS | — |
ai | velox.ai — embed, generate, transcribe (on-device) | Requires model download on first use |
audio | velox.audio — playback and recording | — |
video | velox.video — video file playback | — |
camera | velox.camera — camera device enumeration and capture | — |
microphone | velox.audio recording — microphone input | — |
dialog | velox.dialog — open/save file dialogs, message boxes | — |
clipboard | velox.clipboard — read and write text (readText, writeText) | Image clipboard not yet supported |
notification | velox.notification — OS notifications | macOS requires app bundle |
credentials | velox.credentials — OS keychain (Keychain, Credential Manager, libsecret) | — |
deeplink | velox.deeplink — URL scheme registration and handling | Requires identifier field |
updater | velox.updater — in-app update checks and installation | — |
crash | velox.crash — crash report capture and retrieval | — |
perf | velox.perf — frame timing, memory stats, CPU usage | Dev / diagnostics |
system | velox.system — display info, OS info | — |
battery | velox.system.battery — battery level and charging state | — |
storage | velox.system.storage — disk usage and app data directory | — |
gamepads | velox.system.gamepads — gamepad / controller input | — |
globalShortcuts | velox.globalShortcuts — OS-level keyboard shortcut registration | — |
power | Power sleep/wake events | — |
shell | Spawn shell commands | Use with care — broad OS access |
usb | USB device enumeration | — |
mdns | mDNS service discovery and advertisement | — |
hid | HID device access (joysticks, custom peripherals) | — |
Requesting only what you need
Each capability you declare is a commitment that your app uses that API. Declare only what you genuinely need:
- Fewer capabilities = smaller attack surface
- Capability list is visible to users who inspect the binary
- Future versions may require user consent for sensitive capabilities
Checking capabilities at runtime
import { velox } from 'veloxkit'
if (velox.hasCapability('camera')) {
// camera features available
}Capability scoping (planned for v0.4)
More granular scoping is tracked in GitHub #142 (opens in a new tab):
// Planned — not yet available
capabilities: [
{ name: 'fs', paths: ['~/Documents/my-app/**'] },
{ name: 'network', origins: ['https://api.myservice.com'] },
]