Frontend API client
Use the repo-owned client when you are consuming CortexPilot from a clone or vendored workspace and want convenience helpers for command-tower overview, runs, Workflow Cases, approvals, and role-config preview reads.
Builder quickstart.
CortexPilot is not a full SDK platform today, but it does already expose a useful builder surface across three layers: a thin frontend API client, contract-facing route/type bindings, and a shared presentation substrate.
If your team already understands the workflow and protocol boundary and now wants the shortest repo-owned package path, this page is the right next click.
Current package boundary: the package names referenced here are still private workspace packages. External teams should treat the current adoption path as clone/workspace reuse or vendor copy until a real publish path exists.
Choose the shortest builder entry
| Need | Open first | Why |
|---|---|---|
| Convenience client | @cortexpilot/frontend-api-client |
Use it when you are working inside a clone or shared workspace copy and want overview, runs, Workflow Cases, approvals, and bootstrap reads through one thin helper layer. |
| Route/type boundary | @cortexpilot/frontend-api-contract |
Use it when your real need is generated contract-facing types without backend imports inside the same repo or a vendored package copy. |
| Shared presentation | @cortexpilot/frontend-shared |
Use it when you need repo-owned copy, locale, and status-presentation substrate for dashboard, desktop, and future web consumers inside the same workspace story. |
| Protocol before packages | Read-only MCP quickstart | Use MCP first when your team still needs the truth boundary before it decides which package layer to import. |
What builders get today
Generated type edge
Use the contract package when you are already inside the same repo or a vendored workspace copy and want route/query/type boundaries without importing backend modules into your frontend surface.
Presentation substrate
Use the shared package when you are reusing CortexPilot from a clone or vendored workspace and want brand copy, locale, and status presentation to stay aligned across dashboard, desktop, and future web consumers.
Still repo-owned
These are real builder entrypoints, but they do not turn CortexPilot into a hosted SDK platform, marketplace artifact, or write-capable MCP product.
Not registry-installable yet
The current package names are still private workspace packages. Until a real publish happens, the truthful external path is clone/workspace reuse or vendor copy.
Repo-owned starter path
If you want the shortest runnable builder path inside this repo, start with the repo-owned control-plane starter example instead of rebuilding the bootstrap story from scratch.
node packages/frontend-api-client/examples/control_plane_starter.local.mjs \
--base-url http://127.0.0.1:10000 \
--role WORKER \
--mutation-role TECH_LEAD \
--preview-provider cliproxyapi \
--preview-model gpt-5.4This starter remains preview-first by default. It demonstrates overview + agents + contracts + role-config preview without claiming hosted operator accounts, write-capable MCP, or a full SDK platform.
Guarded operator-only add-ons
--applyon the starter stays a trusted repo-operator flow for role-default changes.- Queue preview/cancel helpers stay trusted operator control-plane add-ons, not the default external builder promise.
- These surfaces do not turn the builder story into hosted mutation or public write-capable MCP.
Fast onboarding order
- Read compatibility matrix if you still need the best next click for Codex / Claude Code / OpenClaw / skills / builders.
- Read read-only MCP quickstart if protocol truth still matters more than packages.
- Read API and contract quickstart for the raw HTTP and contract edge.
- Come back here when your next move is package adoption rather than protocol discovery.