# qip

> qip is a small, deterministic host for composing QIP components over text, bytes, and images across CLI, browser, and web routing workflows.

qip favors explicit contracts and simple pipelines. QIP components are sandboxed (no filesystem, no network, no environment access), and hosts compose them into predictable stage-by-stage processing.

## Core Docs

- [Adopting QIP in existing apps](/docs/adopting-qip.md): Practical guidance for introducing QIP as narrow, portable components inside existing applications.
- [How QIP works](/docs/how-it-works.md): End-to-end runtime model for QIP components, routing, and recipes.
- [Hard limits](/docs/hard-limits.md): Memory, fixed-memory, and host capability policy for QIP components.
- [Component contracts](/docs/component-contract.md): Component types, maturity, execution models, and contract detection.
- [Content component contract](/docs/content-component.md): Required exports, memory buffers, rendering, content types, and composition.
- [Interactive component contract](/docs/interactive-component.md): Framebuffer, events, timing, sizing, and host-loop rules.
- [Uniforms](/docs/uniforms.md): Optional numeric configuration exports and host behavior.
- [Module patterns](/docs/module-patterns.md): Practical implementation patterns for QIP components.
- [Comply](/docs/comply.md): Compliance checks and ABI verification guidance.
- [Running in JavaScript](/docs/running-in-javascript.md): Direct `.wasm` imports with allocation-free UTF-8 encoding into QIP component memory.
- [Running QIP in Python](/docs/running-in-python.md): Load a QIP WebAssembly Core module from disk and call its UTF-8 content contract with Wasmtime.
- [Running QIP in React](/docs/running-in-react.md): Run a QIP WebAssembly Core module in React Client Components or Next.js Server Components, with separate instance-lifetime guidance.
- [qip CLI](/docs/qip-cli.md): Commands, runtime guardrails, and CLI-specific host behavior.

## Router & Site Building

- [Router](/docs/router.md): `qip router` and `qip dev` behavior, route resolution, and WARC flow.
- [Recipes](/docs/recipes.md): Recipe discovery/order and content-vs-WARC processing layers.
- [Content layout](/docs/content.md): Content root layout and path rules.
- [Formats and encodings](/docs/formats.md): Preferred content formats used throughout qip.

## Project Entry Points

- [Homepage source](/index.md): Project overview and examples.
- [Docs index source](/docs/index.md): Top-level docs map.