Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Using the Core Library

Sipp exposes one endpoint-oriented client model across all public package surfaces. See the Library API Overview for the shared SippClient.add, query, chat, and embed contracts, endpoint descriptor reference, and gateway-client symmetry patterns.

Most developers should start here instead of building from source.

Package Surfaces

SurfaceInstallPrimary use
Library API OverviewShared add, query, chat, and embed contracts across all surfaces.
Browsernpm install @sipp/sippBrowser-local GGUF inference, WebGPU/WASM runtime, and browser gateway clients.
Node.jsnpm install @sipp/sipp-serverNode server processes, route handlers, and backend services.
Pythonpip install sipppyPython services, scripts, and gateway clients.
Rustcargo add sipp-rsRust applications and services.
Gateway ServerSource-built todayFirst-party HTTP gateway for local and provider targets.
Gateway DockerDocker from sourceLocal and production container workflows for the gateway server.
Gateway ToolkitSource-built todayRust toolkit for custom gateway applications.

The current release workflow publishes browser npm, Node npm, Python wheels, and Rust crates. The gateway server is documented in the Gateway section as a user-facing deployment surface, but it does not yet have a published binary or public image.

Framework Guides

When integrating JavaScript packages with a framework, see:

Supporting Reference