Home
About
Blog
Products
Forum
Support
Contact

Sunbelt Computer Software

PL/B Language Development and Support

Home
About
Blog
Products
Forum
Support
Contact

Vix.cpp Documentation

Vix.cpp v2.7.0 is here Read the blog

Guides Templates API Modules Registry

Skip to content

Main Navigation Download PDF Registry

Appearance

Sidebar Navigation

Get Started

Welcome to Vix.cpp

What is Vix.cpp?

Installation

Set Up Your Environment

Run Your First C++ File

Create Your First Project

Your First HTTP Server

Guides

Application Workflows

Build a REST API

WebSocket Chat

Static Files

Templates

Game

Backend Essentials

Validation

Authentication

Sessions

CORS

Rate Limiting

Data

JSON

Quick Start

Build JSON

Parse JSON

Write JSON

Safe Access

JPath

Simple Token

JSON with HTTP

Database

Overview

Quick Start

Configuration

SQLite

MySQL

Queries

Connection Pool

Transactions

Migrations

Schema Snapshots

CLI

ORM

Overview

Quick Start

Entities

Mappers

Repositories

Query Builder

Unit of Work

With vix::db

Production Files

Overview

Service

Proxy

Deploy

Environment

Database

WebSocket

Existing C++ Projects

Production

Nginx + systemd

Concepts

The Vix Book

Introduction

Why Vix Exists

Mental Model

Application Model

Runtime Workflow

Build Workflow

Modules and Composition

From Local to Production

Next Steps

Foundations

Vix.cpp vs CMake

C++ Runtime

C++ Developer Toolkit

Why Modules Exist

SDK Profiles

Overview

Default SDK

Web SDK

Data SDK

Desktop SDK

P2P SDK

Game SDK

Agent SDK

Full SDK

Diagnostics

Inspect and Debug

Replay a Run

Runtime Arguments

Diagnostics

Logs

Health Checks

Troubleshooting

vix.app Troubleshooting

Application Modules Troubleshooting

Internals Error Diagnostics

Reference

CLI

Overview

All Commands

Core Workflow

vix repl

vix note

vix new

vix make

vix modules

vix run

vix dev

vix build

vix check

vix tests

vix fmt

Project State

vix clean

vix reset

vix replay

vix task

Dependencies

vix search

vix add

vix install

vix update

vix outdated

vix remove

vix list

Registry and Packages

vix registry

vix store

vix pack

vix verify

vix cache

vix publish

vix unpublish

Runtime and Production

vix env

vix service

vix proxy

vix deploy

vix health

vix logs

vix ws

Data

vix db

vix orm

Advanced Runtime

vix p2p

vix game

vix agent

System

vix info

vix doctor

vix upgrade

vix uninstall

vix completion

vix.app

Overview

Getting Started

Project Types

Manifest Reference

Sources and Includes

Packages and Links

Resources

Output Directory

Compile Options

Libraries

App Modules

Tests

Examples

Project Templates

Overview

Application

Overview

Generated Layout

Module Registry

Manifest

Backend

Overview

Generated Layout

App Bootstrap

Routes and Middleware

Modules Integration

Production Files

Web

Overview

Generated Layout

Rendering Flow

Routes and Views

Production Files

Vue.js

Overview

Generated Layout

Frontend Workflow

Backend Integration

Game

Overview

Generated Layout

Assets and Package

Manifest

Library

Overview

Generated Layout

Examples and Tests

CMake Package

Registry Metadata

Application Modules

Overview

CLI Workflow

Module Layout

Backend Modules

Using with vix.app

Using with CMake

Dependencies and Checks

Generated Registration

Modules

Error

Overview

Result

Error Object

Error Codes

Error Categories

Exception Bridge

API Reference

FS

Overview

Quick Start

Paths and Results

Read and Write

Directories

Listing

Copy, Move, and Remove

Metadata

Options

Errors

API Reference

Path

Overview

Quick Start

Lexical Paths

Join and Normalize

Path Components

Absolute and Relative

Separators and Styles

Options

Errors

API Reference

Core

Overview

App

Architecture

Routing

Handlers

Middleware

Request

Response

Static files

Templates

HTTP server

Sessions

Transports

TLS

Runtime executor

Async and runtime

Configuration

Print

Format

Console

Input

Inspect

OpenAPI

Attached runtime

API Reference

Async

Overview

io_context

Tasks

Spawn

Timers

Cancellation

Thread pool

when_all / when_any

Signals

TCP

UDP

DNS

API Reference

ThreadPool

Overview

Quick Start

Installation

Concepts

Tasks

Futures

Cancellation

Timeouts

Priorities

Task Groups

Shutdown

Metrics

Periodic Tasks

Parallel For

Parallel Map

Parallel Reduce

Best Practices

API Reference

Middleware

Overview

Quick Start

App Integration

Core Concepts

Basics

Security

Authentication

Parsers

HTTP Cache

Performance

Observability

API Reference

Requests

Overview

Quick Start

Client

Session

Request Options

Headers and Params

Bodies

Responses

Timeouts

Redirects and Cookies

HTTPS and TLS

Errors

API Reference

WebSocket

Overview

Quick Start

Concepts

Configuration

Server

Session

Router

Messages

Client

Rooms and Broadcasting

Long polling

HTTP API

Attached runtime

Metrics

Message store

SQLite message store

OpenAPI

Shutdown

API Reference

UI

Overview

Views

HTML

HTML Response

Assets

Forms

Live UI

PWA

App Shell

Examples

Tests

Note

Overview

Quick Start

Document Format

Cells

C++ Cells

Reply Cells

HTML Cells

Runtime

Project Context

Local UI

Export

API Reference

KV

Overview

Opening a database

Keys

Values

Persistence

Recovery

Stats

API Reference

Sync

Overview

WAL

Outbox

Retry Policy

Offline-first Model

API Reference

P2P

Overview

Node

Discovery

Bootstrap

Router

Protocol

WAL Replication

HTTP Control

API Reference

Examples

Overview

Getting Started

Hello App

JSON API

Production Bootstrap

Middleware

Middleware API

HTTP Cache

Request Parsing

Multipart Upload

Form Parser

Sessions and Cookies

Cookies

Session Counter

Authentication

API Key Auth

JWT Auth

RBAC

Static Files

Static Site

Realtime

WebSocket Chat

Database

SQLite API

Async

Background Task

Async App

API Reference

Overview

Core

Print

Format

Console

Inspect

Input

Runtime

HTTP

WebSocket

Async

P2P

Data

JSON

KV

System

ThreadPool

Middleware

Config

Log

Overview

Server Pretty Logs

Advanced

Build Performance

Fast Target Builds

Object Cache

Artifact Cache

Advanced vix.app

Migrating from CMake

CMake Fallback

Best Practices

Internals

Architecture

Runtime Model

Direct Compile

Cache System

Performance

Design Decisions

Contributing

Contribution

Pull Requests

Code of Conduct

Security

On this page

⌂/Docs/Modules/Sync

Edit this page on GitHub

Last updated:

Pager

Previous pageAPI Reference

Released under the MIT License.

Copyright © 2026 Vix.cpp

Vix.cppModern C++ runtime and developer toolkit.

Docs Guides API Modules Registry GitHub

MIT LicenseCopyright © 2026 Vix.cppMaintained by Softadastra

© 2026 Sunbelt Computer Software