Skip to content

component-export.md

Latest commit

 

History

History
39 lines (30 loc) · 1.73 KB

component-export.md

File metadata and controls

39 lines (30 loc) · 1.73 KB
Raw

Export components for separate repositories

Use the cross-platform export script when transferring OSII to an environment where its components will become separate repositories. It copies source and the relevant interface documentation into new directory trees; it does not change the monorepo, initialize Git repositories, or copy generated data.

Preview the default export:

uv run --no-project --python 3.11 python scripts/export_components.py --output ../osii-component-export --dry-run

Create all exports:

uv run --no-project --python 3.11 python scripts/export_components.py --output ../osii-component-export

Export only selected components:

uv run --no-project --python 3.11 python scripts/export_components.py --output ../osii-component-export --components backend,frontend,mcp

The output contains backend, frontend, mcp, tools, notebooks, the shared baseline-processors image source, the four independently exportable local processors, and the HTTP-only model-provider-bridge directory, plus EXPORT_MANIFEST.json. RAG and grounded chat are part of the backend export; they are not a separate component. The backend Dockerfile is adapted to use its exported directory as its build context. The MCP export is prepared to install osii from the receiving environment's package registry. Standalone processor exports receive their own small Dockerfile even though the monorepo publishes them together in one image.

The manifest records the important handoff dependency: publish the OSII backend package internally before packaging the MCP server, and publish the processor SDK before packaging custom processor services. Configure the frontend with the URL of the deployed backend before releasing it.