Chimera Gateway Runtime

Porcelain is an OpenAI-compatible AI workspace that brings together services and clients. Chimera is the service stack—HTTP servers, wrapper processes, operator tools, and backend components (gateway, indexer, vector store, and related runtime). Locus is the client stack—desktop and workspace apps that connect to Chimera. Operator docs are in docs/; milestones in docs/; historical and active plans in docs/plans.

Quick start

You need GNU Make.

On Windows:

pwsh -ExecutionPolicy Bypass -File scripts/install-make.ps1

On Ubuntu and macOS:

bash scripts/install-make.sh

Install and Start (all-in-one)

One-shot onboarding: get dependencies, seed config if needed, build the gateway, and start the supervisor in the background.

make up

Installing Dependencies and Building the Service

Install

Install all the dependencies and build the dependent projects.

make install

make install brings in all build tools and necessary dependencies for the chimera and locus products.

Dependencies

• Go (1.22+) — builds the gateway and BiFrost’s Go code.
• Node.js (20+) — BiFrost’s UI is built with npm during install; it is not shipped inside the chimera binary.
• Git — BiFrost is vendored from a tracked revision, not embedded in the clone.
• GNU Make — single entrypoint for install and build targets from the repo root.
• gcc or clang — BiFrost’s HTTP server is built with CGO; the Go toolchain must invoke a C compiler or the build fails early.
• bash, curl, tar (and unzip on Windows) — reliable way to download and unpack release artifacts the same way on every platform.

Full reference: docs/installation.md.

Configuration

Create local config files from the shipped examples when they are missing.

make configure

Full reference: docs/configuration.md.

Build Chimera and Locus products

The install process all Chimera services and Locus clients.

make build

Start Chimera-Supervisor

The Chimera-Supervisor runs and manages: gateway; vector-store; broker, and indexer.

make chimera-supervisor-run

Further reference: docs/supervisor.md.

Start Locus-Desktop

The Locus-Desktop creates a system native webview that starts the chimera-supervisor, if not started, and then connects to it.

make locus-desktop-run

Testing and Linting

Target	What it does
make fmt-check	Fails if gofmt would change any file
make fmt	Formats all the project code with gofmt
make test	Runs all unit and end-to-end tests for all products
make test-unit	Run all the unit tests
make test-e2e	Run all the end-to-end tests for all products
make precommit	Runs fmt-check, vet, and test

Repo Management and Packaging

Clean up built binaries

Remove all built binaries and other dependencies.

make clean

Documentation

• Index: docs/README.md
• Network / Ports: docs/network.md
• Installation: docs/installation.md
• Configuration: docs/configuration.md
• Supervisor: docs/supervisor.md
• Packaging / releases: docs/packaging.md
• Security: SECURITY.md
• Product / requirements (normative): docs/chimera.plan.md

Development roadmap

Version	Where to read
v0.1	Working notes
v0.1.1	Tool router, metrics, quotas
v0.2.0 – v0.2.2	Shipped releases + capability plan
v0.3.0	Working plan — v0.3
v0.4.0	Working plan — v0.4
Later	Release roadmap in docs/chimera.plan.md

License

Private / unspecified — add a LICENSE if you publish.