Skip to content

The open-source agent harness - the runtime layer that turns an LLM into a working agent.

Rename Trueforge -> TrueForge

Chirag Jaincdb60d703a26
diff --git a/.cursor/rules/server-types-runtime-only.mdc b/.cursor/rules/server-types-runtime-only.mdc
index 7d004c6c3..d551e556d 100644
--- a/.cursor/rules/server-types-runtime-only.mdc
+++ b/.cursor/rules/server-types-runtime-only.mdc
@@ -20,7 +20,7 @@ Canonical `AgentUIServer` / chat / builder / catalog port types live only in
- Need a new field/method on the contract? Change runtime `server/types.ts` first,
publish/bump, then re-export — never fork the shape in the UI SDK.
- React wiring may stay here (`ServerContext`, `ShellModeContext`,
- `TrueforgeServerConfig`). Those modules **import** runtime types; they do not
+ `TrueForgeServerConfig`). Those modules **import** runtime types; they do not
redefine ports.
- Host adapters (e.g. frontend `harnessServer`) widen via generics / intersections
over runtime bases (`SkillMount` / `McpServerMount` stay opaque `object`).
diff --git a/docs/introduction.mdx b/docs/introduction.mdx
index 32f6ac159..862a09c55 100644
--- a/docs/introduction.mdx
+++ b/docs/introduction.mdx
@@ -53,7 +53,7 @@ flowchart LR
style byo stroke-dasharray: 6 4
```
-### Trueforge server
+### TrueForge server
Runs the agent loop. When a user sends a message, the server:
diff --git a/docs/ui-sdk/README.md b/docs/ui-sdk/README.md
index eb0168b50..362ca60e2 100644
--- a/docs/ui-sdk/README.md
+++ b/docs/ui-sdk/README.md
@@ -19,7 +19,7 @@ index.mdx landing page
get-started/ installation, quickstart
concepts/ architecture, agent modes, server contract
guides/ layouts, theming, slots, custom server, MCP OAuth, troubleshooting
-reference/ TrueforgeUI, theme, containers, atoms, hooks, server
+reference/ TrueForgeUI, theme, containers, atoms, hooks, server
images/ logos and screenshots
snippets/ reusable MDX fragments
```
diff --git a/docs/ui-sdk/concepts/architecture.mdx b/docs/ui-sdk/concepts/architecture.mdx
index d78b785de..0dddc3879 100644
--- a/docs/ui-sdk/concepts/architecture.mdx
+++ b/docs/ui-sdk/concepts/architecture.mdx
@@ -6,14 +6,14 @@ description: "The pieces you compose: providers, layouts, containers, and slots.
You can use the SDK at three levels of control. Most applications stay at the first.
<Steps>
- <Step title="Simply use TrueforgeUI">
+ <Step title="Simply use TrueForgeUI">
One component, a `server` and a `layout`. It mounts everything it needs internally.
</Step>
<Step title="Supply your own layout">
Pass a component to `layout` and arrange the exported containers yourself.
</Step>
<Step title="Mount the providers yourself">
- Skip `TrueforgeUI` entirely and compose the providers directly.
+ Skip `TrueForgeUI` entirely and compose the providers directly.
</Step>
</Steps>
@@ -29,7 +29,7 @@ That replacement is what `overrides` does: name a component, supply your own, an
## Provider stack
-`TrueforgeUI` mounts this for you. You only need it when composing manually:
+`TrueForgeUI` mounts this for you. You only need it when composing manually:
```tsx
<SlotsProvider overrides={overrides} theme={theme}>
@@ -46,7 +46,7 @@ That replacement is what `overrides` does: name a component, supply your own, an
Order matters: `SlotsProvider` must be outside `TrueFoundryChatProvider`.
<Warning>
- Composing manually means you own runtime resets. `TrueforgeUI` remounts the chat runtime when the selected agent changes, a new draft starts, or the chat is cleared; a hand-rolled stack does not. Change the `key` on `TrueFoundryChatProvider` yourself at those moments, or stale messages carry over between agents.
+ Composing manually means you own runtime resets. `TrueForgeUI` remounts the chat runtime when the selected agent changes, a new draft starts, or the chat is cleared; a hand-rolled stack does not. Change the `key` on `TrueFoundryChatProvider` yourself at those moments, or stale messages carry over between agents.
</Warning>
## Styling hooks
diff --git a/docs/ui-sdk/get-started/quickstart.mdx b/docs/ui-sdk/get-started/quickstart.mdx
index 0dde55e85..a7bff22ac 100644
--- a/docs/ui-sdk/get-started/quickstart.mdx
+++ b/docs/ui-sdk/get-started/quickstart.mdx
@@ -25,15 +25,15 @@ yarn add @truefoundry/trueforge-ui @truefoundry/trueforge-sdk
## Render the UI
-Point `TrueforgeUI` at your TrueForge server with a Bearer token:
+Point `TrueForgeUI` at your TrueForge server with a Bearer token:
```tsx App.tsx
-import { TrueforgeUI } from "@truefoundry/trueforge-ui";
+import { TrueForgeUI } from "@truefoundry/trueforge-ui";
export default function App() {
return (
<div style={{ height: "100dvh" }}>
- <TrueforgeUI
+ <TrueForgeUI
server={{
type: "trueforge"
}}
@@ -46,6 +46,6 @@ export default function App() {
That is enough to get a full agent chat with streaming, history, and tool calls.
-<Frame caption="What `TrueforgeUI` renders — a full agent chat with streaming, history, and tool calls.">
- ![The TrueforgeUI component rendering an agent chat with an agent-steps panel and a streamed response](/images/agent-composer-with-library.png)
+<Frame caption="What `TrueForgeUI` renders — a full agent chat with streaming, history, and tool calls.">
+ ![The TrueForgeUI component rendering an agent chat with an agent-steps panel and a streamed response](/images/agent-composer-with-library.png)
</Frame>
diff --git a/docs/ui-sdk/guides/layouts-and-theme.mdx b/docs/ui-sdk/guides/layouts-and-theme.mdx
index 3c7130f08..34bddbbec 100644
--- a/docs/ui-sdk/guides/layouts-and-theme.mdx
+++ b/docs/ui-sdk/guides/layouts-and-theme.mdx
@@ -12,7 +12,7 @@ The sidebar view is the default layout. You can customize the layout by passing
A full-page chat experience with persistent conversation history in a left sidebar. The default choice for a dedicated chat surface.
```tsx
- <TrueforgeUI server={server} layout="sidebar" />
+ <TrueForgeUI server={server} layout="sidebar" />
```
<Frame caption="Sidebar: full-page chat with the thread list pinned on the left.">
@@ -23,7 +23,7 @@ The sidebar view is the default layout. You can customize the layout by passing
Chat history is tucked into an overlay drawer and can be opened using the history icon. Ideal for smaller viewports, such as tablets and compact monitors, where screen space is limited.
```tsx
- <TrueforgeUI server={server} layout="drawer" />
+ <TrueForgeUI server={server} layout="drawer" />
```
<Frame caption="Drawer: the thread list collapses into an overlay for narrow viewports.">
@@ -34,7 +34,7 @@ The sidebar view is the default layout. You can customize the layout by passing
A chat panel pinned to the right edge, using the available space up to a maximum width of 400px.
```tsx
- <TrueforgeUI server={server} layout="dock" />
+ <TrueForgeUI server={server} layout="dock" />
```
<Frame caption="Dock: a compact panel pinned to the right edge, up to a 400px cap.">
@@ -45,7 +45,7 @@ The sidebar view is the default layout. You can customize the layout by passing
A floating chat launcher that expands into a compact chat panel when opened.
```tsx
- <TrueforgeUI server={server} layout="widget" />
+ <TrueForgeUI server={server} layout="widget" />
```
<Frame caption="Widget: a floating launcher that expands into a compact chat panel.">
@@ -75,7 +75,7 @@ type ThemeConfig = {
```
```tsx App.tsx
-<TrueforgeUI
+<TrueForgeUI
...
theme={{
preset: "trueforge",
@@ -119,7 +119,7 @@ If you want the SDK theme to follow your application’s theme, set this value t
You can also provide separate logos for light and dark modes, allowing your branding to remain visible and optimized for each theme, as shown below:
```tsx App.tsx
-<TrueforgeUI
+<TrueForgeUI
...
theme={{
...
@@ -152,7 +152,7 @@ function MyCustomLogo() {
return <img src={logoUrl} alt="My custom logo" />;
}
-<TrueforgeUI
+<TrueForgeUI
...
overrides={{ BrandLogo: MyCustomLogo }}
/>
diff --git a/docs/ui-sdk/guides/layouts.mdx b/docs/ui-sdk/guides/layouts.mdx
index 3d8a781cf..3fecaac5a 100644
--- a/docs/ui-sdk/guides/layouts.mdx
+++ b/docs/ui-sdk/guides/layouts.mdx
@@ -11,7 +11,7 @@ The sidebar view is the default option. You can pass predefined values - sidebar
Full-page chat with a persistent chat history on the left. The default choice for a dedicated chat surface.
```tsx
- <TrueforgeUI server={server} layout="sidebar" />
+ <TrueForgeUI server={server} layout="sidebar" />
```
<Frame caption="Sidebar: full-page chat with the thread list pinned on the left.">
@@ -22,7 +22,7 @@ The sidebar view is the default option. You can pass predefined values - sidebar
Chat history list collapses into an overlay drawer. Click on the history icon to view the past conversations. Suited to narrower viewports.
```tsx
- <TrueforgeUI server={server} layout="drawer" />
+ <TrueForgeUI server={server} layout="drawer" />
```
<Frame caption="Drawer: the thread list collapses into an overlay for narrow viewports.">
@@ -33,7 +33,7 @@ The sidebar view is the default option. You can pass predefined values - sidebar
A panel pinned to the right edge, filling the available width up to a 400px cap.
```tsx
- <TrueforgeUI server={server} layout="dock" />
+ <TrueForgeUI server={server} layout="dock" />
```
<Frame caption="Dock: a compact panel pinned to the right edge, up to a 400px cap.">
@@ -44,7 +44,7 @@ The sidebar view is the default option. You can pass predefined values - sidebar
Floating launcher that expands into a compact chat panel.
```tsx
- <TrueforgeUI server={server} layout="widget" />
+ <TrueForgeUI server={server} layout="widget" />
```
<Frame caption="Widget: a floating launcher that expands into a compact chat panel.">
diff --git a/docs/ui-sdk/guides/troubleshooting.mdx b/docs/ui-sdk/guides/troubleshooting.mdx
index f64b853cd..f4842d3cb 100644
--- a/docs/ui-sdk/guides/troubleshooting.mdx
+++ b/docs/ui-sdk/guides/troubleshooting.mdx
@@ -44,7 +44,7 @@ description: "Common failure modes and their causes."
```tsx
<div className="flex h-dvh min-h-0 w-full flex-1 flex-col">
- <TrueforgeUI /* ... */ className="h-full min-h-0" />
+ <TrueForgeUI /* ... */ className="h-full min-h-0" />
</div>
```
@@ -79,7 +79,7 @@ description: "Common failure modes and their causes."
</Accordion>
<Accordion title="Only the OAuth screen renders — no chat">
- A `screenType=mcp-auth` query parameter is present on the URL. `TrueforgeUI` renders the OAuth completion screen exclusively in that case. Keep the callback on its own route; see [MCP OAuth](/ui-sdk/guides/mcp-oauth).
+ A `screenType=mcp-auth` query parameter is present on the URL. `TrueForgeUI` renders the OAuth completion screen exclusively in that case. Keep the callback on its own route; see [MCP OAuth](/ui-sdk/guides/mcp-oauth).
</Accordion>
<Accordion title="Dark mode fights with the host application">
@@ -91,6 +91,6 @@ description: "Common failure modes and their causes."
</Accordion>
<Accordion title="SSR or React Server Components errors">
- The package is ESM-only and client-only. Mount `TrueforgeUI` from a client component — in Next.js App Router, a file with `"use client"` at the top.
+ The package is ESM-only and client-only. Mount `TrueForgeUI` from a client component — in Next.js App Router, a file with `"use client"` at the top.
</Accordion>
</AccordionGroup>
\ No newline at end of file
diff --git a/docs/ui-sdk/reference/containers.mdx b/docs/ui-sdk/reference/containers.mdx
index 2d1324c4e..ae9d2078a 100644
--- a/docs/ui-sdk/reference/containers.mdx
+++ b/docs/ui-sdk/reference/containers.mdx
@@ -31,7 +31,7 @@ type TrueFoundryChatProviderProps = {
Use `agent` to select which agent the provider runs; `agentName` is a string-only shorthand kept
for compatibility. `listSessionsAgentId` is forwarded to `listSessions` to filter the history
-list to a single agent — that is how `TrueforgeUI` scopes the thread list.
+list to a single agent — that is how `TrueForgeUI` scopes the thread list.
## Message and content wiring
diff --git a/docs/ui-sdk/reference/server.mdx b/docs/ui-sdk/reference/server.mdx
index 9abfde574..7d98bd071 100644
--- a/docs/ui-sdk/reference/server.mdx
+++ b/docs/ui-sdk/reference/server.mdx
@@ -48,7 +48,7 @@ to reference:
<AccordionGroup>
<Accordion title="Server interfaces">
`AgentUIServer`, `AgentChatServer`, `AgentBuilderServer`,
- `AgentBuilderCapabilitiesResponse`, `CatalogServer`, `TrueforgeServerConfig`,
+ `AgentBuilderCapabilitiesResponse`, `CatalogServer`, `TrueForgeServerConfig`,
`CreateTrueFoundryServerOptions`, `TrueFoundryServer`.
</Accordion>
<Accordion title="Sessions and turns">
diff --git a/docs/ui-sdk/reference/trueforge-ui.mdx b/docs/ui-sdk/reference/trueforge-ui.mdx
index 8c2f4dc9b..4a885d681 100644
--- a/docs/ui-sdk/reference/trueforge-ui.mdx
+++ b/docs/ui-sdk/reference/trueforge-ui.mdx
@@ -1,18 +1,18 @@
---
-title: "TrueforgeUI"
+title: "TrueForgeUI"
description: "The entry component and every prop it accepts."
---
```tsx
-import { TrueforgeUI } from "@truefoundry/trueforge-ui";
+import { TrueForgeUI } from "@truefoundry/trueforge-ui";
```
## Properties
-<ParamField path="server" type="TrueforgeServerConfig" required>
+<ParamField path="server" type="TrueForgeServerConfig" required>
Where the chat gets its data. Either a built-in config object or a ready `AgentUIServer`.
- <Expandable title="TrueforgeServerConfig">
+ <Expandable title="TrueForgeServerConfig">
<ParamField path="type" type='"truefoundry" | "trueforge"'>
Omit entirely to pass an `AgentUIServer` object directly — there is no `"custom"` wrapper.
`"trueforge"` loads the Harness adapter (`plugins/trueforge-agent-server-adapter`). See
@@ -234,7 +234,7 @@ Persisted sessions remain available through the thread list.
## Example
```tsx
-<TrueforgeUI
+<TrueForgeUI
server={{ type: "truefoundry", apiKey, controlPlaneURL }}
layout="sidebar"
agentConfig={{ mode: "AgentComposer", defaultAgentSpec: { model: { name: "openai-main/gpt-4.1" } } }}
diff --git a/docs/ui-sdk/setup-custom-servers/connect-with-truefoundry.mdx b/docs/ui-sdk/setup-custom-servers/connect-with-truefoundry.mdx
index 6b6bf5721..22bc70bc7 100644
--- a/docs/ui-sdk/setup-custom-servers/connect-with-truefoundry.mdx
+++ b/docs/ui-sdk/setup-custom-servers/connect-with-truefoundry.mdx
@@ -5,12 +5,12 @@ title: "Connect with TrueFoundry"
The zero-config path. The SDK builds the agent UI server from your API key and control plane URL; the gateway URL is optional and resolved from the control plane when omitted.
```jsx App.tsx
-import { TrueforgeUI } from "@truefoundry/trueforge-ui";
+import { TrueForgeUI } from "@truefoundry/trueforge-ui";
export default function App() {
return (
<div style={{ height: "100dvh" }}>
- <TrueforgeUI
+ <TrueForgeUI
server={{
type: "truefoundry",
apiKey: {{API_KEY}},
@@ -33,7 +33,7 @@ If you need to hold the resolved `AgentUIServer` — to wrap it, log through it,
```tsx App.tsx
import { useEffect, useState } from "react";
-import { TrueforgeUI } from "@truefoundry/trueforge-ui";
+import { TrueForgeUI } from "@truefoundry/trueforge-ui";
import {
createTrueFoundryAgentUIServer,
type TrueFoundryAgentUIServer,
@@ -55,7 +55,7 @@ export default function App() {
return (
<div style={{ height: "100dvh" }}>
- <TrueforgeUI server={server} layout="sidebar" />
+ <TrueForgeUI server={server} layout="sidebar" />
</div>
);
}
@@ -68,7 +68,7 @@ export default function App() {
To keep TrueFoundry's hosted chat streaming but serve the builder surfaces — models, skills, connectors, and the agent library — from your own backend, compose the gateway chat port with your callbacks through `createTrueFoundryServer`. The stubs below return empty lists, which is enough to mount; fill them in as you add agent management.
```jsx App.tsx
-import { TrueforgeUI, createTrueFoundryServer } from "@truefoundry/trueforge-ui";
+import { TrueForgeUI, createTrueFoundryServer } from "@truefoundry/trueforge-ui";
import { createTrueFoundryChatServer } from "@truefoundry/assistant-ui-runtime/plugins/truefoundry-agent-server-adapter";
const chatServer = createTrueFoundryChatServer({
@@ -91,7 +91,7 @@ const server = createTrueFoundryServer({
export default function App() {
return (
<div style={{ height: "100dvh" }}>
- <TrueforgeUI server={server} layout="sidebar" />
+ <TrueForgeUI server={server} layout="sidebar" />
</div>
);
}
diff --git a/docs/ui-sdk/setup-custom-servers/custom-server.mdx b/docs/ui-sdk/setup-custom-servers/custom-server.mdx
index 7c68afb20..5b08e1f6b 100644
--- a/docs/ui-sdk/setup-custom-servers/custom-server.mdx
+++ b/docs/ui-sdk/setup-custom-servers/custom-server.mdx
@@ -92,7 +92,7 @@ export const server: AgentUIServer = {
Declaring `sandbox` and `skill` as disabled is the honest starting point — the UI then hides those affordances instead of offering controls your backend cannot serve. Flip them on as you implement each.
```tsx title="App.tsx"
-<TrueforgeUI server={server} layout="sidebar" agentConfig={{ mode: "AgentLibrary" }} />
+<TrueForgeUI server={server} layout="sidebar" agentConfig={{ mode: "AgentLibrary" }} />
```
## Streaming
@@ -204,8 +204,8 @@ See [Widening the types](/ui-sdk/setup-custom-servers/server-contract#widening-t
## Attachments
-Attachment handling defaults to `trueFoundryAttachmentAdapter`. Override it through the `adapters` prop on `TrueforgeUI` if your backend stores uploads differently.
+Attachment handling defaults to `trueFoundryAttachmentAdapter`. Override it through the `adapters` prop on `TrueForgeUI` if your backend stores uploads differently.
```tsx
-<TrueforgeUI server={server} layout="sidebar" adapters={{ attachments: myAdapter }} />
+<TrueForgeUI server={server} layout="sidebar" adapters={{ attachments: myAdapter }} />
```
\ No newline at end of file
diff --git a/docs/ui-sdk/setup-custom-servers/server-contract.mdx b/docs/ui-sdk/setup-custom-servers/server-contract.mdx
index 95700c0b4..bd1a19f32 100644
--- a/docs/ui-sdk/setup-custom-servers/server-contract.mdx
+++ b/docs/ui-sdk/setup-custom-servers/server-contract.mdx
@@ -6,7 +6,7 @@ description: "The interfaces a backend must implement for the SDK to talk to it.
The `server` prop accepts either a built-in config object or an object implementing `AgentUIServer`.
```ts
-type TrueforgeServerConfig =
+type TrueForgeServerConfig =
| {
type: "truefoundry";
apiKey: string;
diff --git a/docs/ui-sdk/setup-custom-ui/custom-theme.mdx b/docs/ui-sdk/setup-custom-ui/custom-theme.mdx
index cc46312f0..6d6efc01f 100644
--- a/docs/ui-sdk/setup-custom-ui/custom-theme.mdx
+++ b/docs/ui-sdk/setup-custom-ui/custom-theme.mdx
@@ -15,10 +15,10 @@ type ThemeConfig = {
};
```
-Pass the theme object on `TrueforgeUI`:
+Pass the theme object on `TrueForgeUI`:
```tsx App.tsx
-<TrueforgeUI
+<TrueForgeUI
server={server}
layout="sidebar"
theme={{
diff --git a/docs/ui-sdk/setup-custom-ui/mcp-oauth.mdx b/docs/ui-sdk/setup-custom-ui/mcp-oauth.mdx
index 07e919fe9..33766f13f 100644
--- a/docs/ui-sdk/setup-custom-ui/mcp-oauth.mdx
+++ b/docs/ui-sdk/setup-custom-ui/mcp-oauth.mdx
@@ -81,7 +81,7 @@ export default function McpCallback() {
```
<Warning>
- Whenever `screenType=mcp-auth` is present in the URL, `TrueforgeUI` renders **only** the OAuth
+ Whenever `screenType=mcp-auth` is present in the URL, `TrueForgeUI` renders **only** the OAuth
completion screen — no layout, no chat. This applies to any route that mounts the component,
so keep the callback on its own route.
</Warning>
diff --git a/docs/ui-sdk/setup-custom-ui/slot-overrides.mdx b/docs/ui-sdk/setup-custom-ui/slot-overrides.mdx
index bc15fc320..829c8eb8b 100644
--- a/docs/ui-sdk/setup-custom-ui/slot-overrides.mdx
+++ b/docs/ui-sdk/setup-custom-ui/slot-overrides.mdx
@@ -7,7 +7,7 @@ Pass an `overrides` object to replace a built-in component. Your version is used
that component appears, without you having to find each place it is rendered.
```tsx
-import { TrueforgeUI, type AssistantMessageBubbleProps } from "@truefoundry/trueforge-ui";
+import { TrueForgeUI, type AssistantMessageBubbleProps } from "@truefoundry/trueforge-ui";
function MyBubble({ children, error, actionBar, className }: AssistantMessageBubbleProps) {
return (
@@ -19,7 +19,7 @@ function MyBubble({ children, error, actionBar, className }: AssistantMessageBub
);
}
-<TrueforgeUI
+<TrueForgeUI
server={server}
layout="sidebar"
overrides={{ AssistantMessageBubble: MyBubble }}
@@ -101,7 +101,7 @@ names as you type inside the `overrides` object, and hovering a name shows the c
signature you need to match. That is the fastest way to find a slot. The groups above list the
ones most applications touch.
-## Overriding outside TrueforgeUI
+## Overriding outside TrueForgeUI
If you compose providers manually, pass overrides to `SlotsProvider` and keep it outside
`TrueFoundryChatProvider`:
diff --git a/packages/frontend/README.md b/packages/frontend/README.md
index dbf45dc97..b1159021b 100644
--- a/packages/frontend/README.md
+++ b/packages/frontend/README.md
@@ -10,14 +10,14 @@ Built on:
server={{ type: 'trueforge', baseUrl, fetch }}
→ plugins/trueforge-agent-server-adapter
(chat + builder + settings catalogs)
- → TrueforgeUI (layout="sidebar")
+ → TrueForgeUI (layout="sidebar")
```
[`App.tsx`](src/App.tsx) owns product chrome only:
- auth gate / welcome / logout (`authFetch`, `authSession`)
- boot: first model → `defaultAgentSpec`, `initialSettingsOpen`
-- `<TrueforgeUI server={{ type: 'trueforge', baseUrl: '/', fetch: authAwareFetch }} />`
+- `<TrueForgeUI server={{ type: 'trueforge', baseUrl: '/', fetch: authAwareFetch }} />`
Chat, agent library, and settings catalogs are composed inside the UI SDK plugin —
the host does **not** call `createTrueFoundryServer` or maintain harness adapters.
@@ -55,7 +55,7 @@ session cookies.
Harness ↔ `AgentUIServer` mapping lives in
[`@truefoundry/trueforge-ui/plugins/trueforge-agent-server-adapter`](../trueforge-ui/src/plugins/trueforge-agent-server-adapter/).
-Hosts that need the factory outside `<TrueforgeUI />` can import
+Hosts that need the factory outside `<TrueForgeUI />` can import
`createTrueForgeAgentUIServer` from that subpath.
## Production
diff --git a/packages/frontend/src/App.tsx b/packages/frontend/src/App.tsx
index d07413b2e..1e417d9eb 100644
--- a/packages/frontend/src/App.tsx
+++ b/packages/frontend/src/App.tsx
@@ -1,4 +1,4 @@
-import { getErrorMessage, ThemeProvider, TrueforgeUI, type SlotOverrides } from '@truefoundry/trueforge-ui';
+import { getErrorMessage, ThemeProvider, TrueForgeUI, type SlotOverrides } from '@truefoundry/trueforge-ui';
import {
createTrueForgeClient,
getCapabilities,
@@ -13,7 +13,7 @@ import { parseAuthErrorReason } from './authStatusSearch';
import { GetStartedScreen } from './GetStartedScreen';
import { LogoutButton } from './LogoutButton';
-/** Shared cookie/OIDC fetch for boot helpers and `<TrueforgeUI server />`. */
+/** Shared cookie/OIDC fetch for boot helpers and `<TrueForgeUI server />`. */
const authAwareFetch = createAuthAwareFetch();
const bootClient = createTrueForgeClient({ fetch: authAwareFetch });
@@ -142,7 +142,7 @@ export function App() {
return (
<div className="app-root">
- <TrueforgeUI
+ <TrueForgeUI
server={{ type: 'trueforge', baseUrl: '/', fetch: authAwareFetch }}
theme={{
brand: {
diff --git a/packages/trueforge-ui/CHANGELOG.md b/packages/trueforge-ui/CHANGELOG.md
index c79f4da08..251b0c701 100644
--- a/packages/trueforge-ui/CHANGELOG.md
+++ b/packages/trueforge-ui/CHANGELOG.md
@@ -4,7 +4,7 @@
### Minor Changes
-- 2f08a99: Remember plain-draft composer choices (model, skills, MCP connectors, config) across New Chat and reloads via localStorage. Edit-flow and immutable library agents are unchanged. `TrueforgeUI` `layout` is optional and defaults to `"sidebar"`.
+- 2f08a99: Remember plain-draft composer choices (model, skills, MCP connectors, config) across New Chat and reloads via localStorage. Edit-flow and immutable library agents are unchanged. `TrueForgeUI` `layout` is optional and defaults to `"sidebar"`.
- b56c003: Initial 0.1.0-rc.1 prerelease of all public packages.
### Patch Changes
@@ -20,7 +20,7 @@
### Minor Changes
-- 2f08a99: Remember plain-draft composer choices (model, skills, MCP connectors, config) across New Chat and reloads via localStorage. Edit-flow and immutable library agents are unchanged. `TrueforgeUI` `layout` is optional and defaults to `"sidebar"`.
+- 2f08a99: Remember plain-draft composer choices (model, skills, MCP connectors, config) across New Chat and reloads via localStorage. Edit-flow and immutable library agents are unchanged. `TrueForgeUI` `layout` is optional and defaults to `"sidebar"`.
### Patch Changes
@@ -83,8 +83,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
config choices are remembered (in-memory + `localStorage`) and seed the next
New Chat after reload. Stale catalog entries are pruned once catalogs load.
Edit-flow (`agentId` set) and immutable library agents are unchanged.
-- **Optional `layout`** — `<TrueforgeUI />` `layout` prop defaults to `"sidebar"`.
-- **`type: "trueforge"` built-in server** — `<TrueforgeUI server={{ type: 'trueforge', baseUrl?, token?, fetch? }} />`
+- **Optional `layout`** — `<TrueForgeUI />` `layout` prop defaults to `"sidebar"`.
+- **`type: "trueforge"` built-in server** — `<TrueForgeUI server={{ type: 'trueforge', baseUrl?, token?, fetch? }} />`
resolves a full Harness `AgentUIServer` via
`@truefoundry/trueforge-ui/plugins/trueforge-agent-server-adapter`
(`createTrueForgeAgentUIServer`), including chat, builder, and default settings
@@ -164,9 +164,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
Save Agent / welcome chrome key off `isMutable`, not draft|named.
Hosts that inspected `mode.type` must switch to `mode.status` /
`mode.isMutable` (see `shellIsMutable`).
-- **Renamed `TrueFoundryAssistantUI` → `TrueforgeUI`** (props type
- `TrueFoundryAssistantUIProps` → `TrueforgeUIProps`). Update imports and JSX.
-- **`TrueforgeUI` agent props** — replaced top-level `agentName` and
+- **Renamed `TrueFoundryAssistantUI` → `TrueForgeUI`** (props type
+ `TrueFoundryAssistantUIProps` → `TrueForgeUIProps`). Update imports and JSX.
+- **`TrueForgeUI` agent props** — replaced top-level `agentName` and
`defaultAgentSpec` with a single discriminated `agentConfig`. There is no
compat shim; hosts must update call sites.
- **Icons use Lucide** (`lucide-react`) instead of Font Awesome. Default
@@ -220,10 +220,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
`CreateSandboxRequest`, `UpdateSandboxRequest`, `SandboxCatalogServer`.
`apiKey` is never stored in the catalog and is optional on update (blank keeps
the existing key).
-- `TrueforgeBuiltInServerConfig` exported for hosts that build the built-in
+- `TrueForgeBuiltInServerConfig` exported for hosts that build the built-in
config separately.
-- **`agentConfig` shell modes** on `TrueforgeUI` /
+- **`agentConfig` shell modes** on `TrueForgeUI` /
`ShellModeProvider`:
- `SingleAgent` — locked named agent (`name` required)
- `AgentLibrary` — Agents Library only; idle empty state until pick; no New Chat
@@ -259,8 +259,8 @@ import { TrueFoundryAssistantUI } from '@truefoundry/trueforge-ui';
<TrueFoundryAssistantUI server={server} layout="sidebar" />;
// After
-import { TrueforgeUI } from '@truefoundry/trueforge-ui';
-<TrueforgeUI server={server} layout="sidebar" />;
+import { TrueForgeUI } from '@truefoundry/trueforge-ui';
+<TrueForgeUI server={server} layout="sidebar" />;
```
#### `agentConfig` (host must update)
@@ -282,12 +282,12 @@ import { TrueforgeUI } from '@truefoundry/trueforge-ui';
/>
// After
-<TrueforgeUI
+<TrueForgeUI
server={server}
layout="sidebar"
agentConfig={{ mode: "SingleAgent", name: "support-agent" }}
/>
-<TrueforgeUI
+<TrueForgeUI
server={server}
layout="sidebar"
agentConfig={{
@@ -336,7 +336,7 @@ import { TrueforgeUI } from '@truefoundry/trueforge-ui';
### Added
-- `TrueforgeUI` quick-start component with `layout`: `sidebar` | `drawer` |
+- `TrueForgeUI` quick-start component with `layout`: `sidebar` | `drawer` |
`dock` | `widget` (slots outside the chat provider so toast overrides apply).
- Curated re-exports: `useAui`, `useAuiState`, `AssistantState` from the main
barrel and `@truefoundry/trueforge-ui/assistant-ui`; `useTheme` from the main
@@ -368,7 +368,7 @@ import { TrueforgeUI } from '@truefoundry/trueforge-ui';
- Font Awesome packages this SDK imports (`fontawesome-svg-core`,
`free-solid-svg-icons`) moved to `dependencies`.
- `SlotOverrides` is `Partial<AtomSlots>` only (no `Record<string, unknown>`).
-- `TrueforgeUI` lazy-layout `Suspense` fallback is a pulse skeleton
+- `TrueForgeUI` lazy-layout `Suspense` fallback is a pulse skeleton
instead of blank.
- README reordered: quick start (prefer `client`) before advanced sections.
diff --git a/packages/trueforge-ui/README.md b/packages/trueforge-ui/README.md
index c080ed261..b6c433534 100644
--- a/packages/trueforge-ui/README.md
+++ b/packages/trueforge-ui/README.md
@@ -12,7 +12,7 @@ Powered by [assistant-ui](https://www.assistant-ui.com/), it follows the familia
- **Fully themeable** — Use built-in themes inspired by **TrueFoundry**, **ChatGPT**, **Claude**, and **Gemini**, or create your own brand identity.
- **Composable by design** — Swap layouts, components, and interaction patterns to fit your product.
-- **Backend agnostic** — Connect to **TrueFoundry**, **TrueForge**, or any custom API via `TrueforgeServerConfig`.
+- **Backend agnostic** — Connect to **TrueFoundry**, **TrueForge**, or any custom API via `TrueForgeServerConfig`.
- **Open source** — Extend, customize, and contribute without vendor lock-in.
- **Built on assistant-ui** — Leverage a modern React foundation with seamless shadcn/ui and Tailwind CSS integration.
- **Production ready** — Focus on your agents while the SDK handles the chat experience.
@@ -27,7 +27,7 @@ Bring your own **brand, colors, layout, components, and server**—the Agent SDK
- [Installation](#installation)
- [Getting started](#getting-started)
-- [`<TrueforgeUI />` props](#trueforgeui--props)
+- [`<TrueForgeUI />` props](#trueforgeui--props)
- [Theming](#theming)
- [Content classNames](#content-classnames)
- [Brand / logo](#brand--logo)
@@ -60,7 +60,7 @@ and your app chrome work alongside the SDK. In the host stylesheet:
@import 'tailwindcss';
```
-SDK styles (tokens, utilities, OpenUI) load automatically when `TrueforgeUI` /
+SDK styles (tokens, utilities, OpenUI) load automatically when `TrueForgeUI` /
`ThemeProvider` mounts — you do **not** need to import the SDK stylesheet for
client-only apps.
@@ -83,12 +83,12 @@ Zero-config path: the SDK builds the agent UI server from your API key and
control plane URL (optional explicit gateway URL).
```tsx
-import { TrueforgeUI } from '@truefoundry/trueforge-ui';
+import { TrueForgeUI } from '@truefoundry/trueforge-ui';
export default function App() {
return (
<div style={{ height: '100dvh' }}>
- <TrueforgeUI
+ <TrueForgeUI
server={{
type: 'truefoundry',
apiKey: process.env.TFY_API_KEY!,
@@ -118,12 +118,12 @@ pnpm add @truefoundry/trueforge-sdk
**Bearer token (embeds / remote API):**
```tsx
-import { TrueforgeUI } from '@truefoundry/trueforge-ui';
+import { TrueForgeUI } from '@truefoundry/trueforge-ui';
export default function App() {
return (
<div style={{ height: '100dvh' }}>
- <TrueforgeUI
+ <TrueForgeUI
server={{
type: 'trueforge',
baseUrl: process.env.TRUEFORGE_BASE_URL, // optional; default '/'
@@ -140,7 +140,7 @@ export default function App() {
auth-aware wrapper that follows OIDC cookies):
```tsx
-<TrueforgeUI
+<TrueForgeUI
server={{
type: 'trueforge',
baseUrl: '/',
@@ -157,7 +157,7 @@ auth-aware wrapper that follows OIDC cookies):
Optional: pass `catalog` to override the built-in settings catalogs, or import
`createTrueForgeAgentUIServer` from
`@truefoundry/trueforge-ui/plugins/trueforge-agent-server-adapter` when you need
-the factory outside `<TrueforgeUI />`.
+the factory outside `<TrueForgeUI />`.
**Custom** — bring your own `AgentUIServer`
@@ -165,7 +165,7 @@ Use this when you compose chat + builder yourself (e.g. chat-only gateway
adapter + stub catalog, or a full host BFF). Pass the server object directly.
```tsx
-import { TrueforgeUI, createTrueFoundryServer } from '@truefoundry/trueforge-ui';
+import { TrueForgeUI, createTrueFoundryServer } from '@truefoundry/trueforge-ui';
import { createTrueFoundryChatServer } from '@truefoundry/assistant-ui-runtime/plugins/truefoundry-agent-server-adapter';
const chatServer = createTrueFoundryChatServer({
@@ -185,18 +185,18 @@ const server = createTrueFoundryServer({
export default function App() {
return (
<div style={{ height: '100dvh' }}>
- <TrueforgeUI server={server} layout="sidebar" />
+ <TrueForgeUI server={server} layout="sidebar" />
</div>
);
}
```
-## `<TrueforgeUI />` props
+## `<TrueForgeUI />` props
-`<TrueforgeUI />` is the single entry point. Every capability is driven by a prop.
+`<TrueForgeUI />` is the single entry point. Every capability is driven by a prop.
```tsx
-<TrueforgeUI
+<TrueForgeUI
server={{
type: 'truefoundry',
apiKey: process.env.TFY_API_KEY!,
@@ -218,7 +218,7 @@ export default function App() {
| Prop | Type | Required | Description |
| ------------------ | -------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------ |
-| `server` | `TrueforgeServerConfig` | ✅ | Built-in config (`truefoundry` / `trueforge`) **or** a ready `AgentUIServer`. |
+| `server` | `TrueForgeServerConfig` | ✅ | Built-in config (`truefoundry` / `trueforge`) **or** a ready `AgentUIServer`. |
| `layout` | `LayoutProp` | ✅ | Built-in layout string **or** a custom React component. |
| `agentConfig` | `AgentConfig` | — | Shell mode: SingleAgent / AgentLibrary / AgentComposer / AgentLibraryWithComposer. Defaults to library + composer. |
| `theme` | `ThemeConfig` | — | Preset, mode, tokens, brand, icons, **content `classNames`** (see [Theming](#theming)). |
@@ -227,7 +227,7 @@ export default function App() {
| `initialSessionId` | `string` | — | Resume a specific session. |
| `onError` | `(error: unknown) => void` | — | Host error hook (runtime + server init). |
-Later sections use `server` as a `TrueforgeServerConfig` (usually `type: "truefoundry"`). For a host-built port, pass the `AgentUIServer` directly.
+Later sections use `server` as a `TrueForgeServerConfig` (usually `type: "truefoundry"`). For a host-built port, pass the `AgentUIServer` directly.
---
@@ -242,7 +242,7 @@ const server = {
controlPlaneURL: process.env.TFY_CONTROL_PLANE_URL!,
};
-<TrueforgeUI
+<TrueForgeUI
server={server}
layout="sidebar"
theme={{
@@ -280,11 +280,11 @@ See [docs/theming.md](./docs/theming.md) for presets, controlled vs uncontrolled
## Content classNames
Style content renderers (markdown, code fences, OpenUI, Monaco) without swapping
-slots. Pass `theme.classNames` on `<TrueforgeUI />` — values merge onto the
+slots. Pass `theme.classNames` on `<TrueForgeUI />` — values merge onto the
defaults via `cn()`:
```tsx
-<TrueforgeUI
+<TrueForgeUI
server={server}
layout="sidebar"
theme={{
@@ -324,7 +324,7 @@ package). Host CSS on `.aui-markdown` / `.aui-syntax-highlighter` / `.aui-openui
**Base layouts** — pass `theme.brand` and the SDK positions the mark + name in the default slots:
```tsx
-<TrueforgeUI
+<TrueForgeUI
server={server}
layout="sidebar"
theme={{
@@ -340,7 +340,7 @@ package). Host CSS on `.aui-markdown` / `.aui-syntax-highlighter` / `.aui-openui
the resolved mode. `href` wraps the logo in a same-tab link:
```tsx
-<TrueforgeUI
+<TrueForgeUI
server={server}
layout="sidebar"
theme={{
@@ -358,7 +358,7 @@ Set only one mode and it is used for both. `name` labels the image, so no `alt`
component, override the `BrandLogo` slot, the same way you replace any other atom:
```tsx
-<TrueforgeUI server={server} layout="sidebar" overrides={{ BrandLogo: MyMark }} />
+<TrueForgeUI server={server} layout="sidebar" overrides={{ BrandLogo: MyMark }} />
```
**Custom layouts** — import `BrandLogo` and place it anywhere; pair it with `useBrandName()` when you also want the name as text (see [Custom layouts](#custom-layouts)).
@@ -384,22 +384,22 @@ In library modes, picking an agent from the Agents Library switches to a named c
{
/* Library + draft (default) */
}
-<TrueforgeUI server={server} layout="sidebar" />;
+<TrueForgeUI server={server} layout="sidebar" />;
{
/* Named-only lock */
}
-<TrueforgeUI server={server} layout="sidebar" agentConfig={{ mode: 'SingleAgent', name: 'support-agent' }} />;
+<TrueForgeUI server={server} layout="sidebar" agentConfig={{ mode: 'SingleAgent', name: 'support-agent' }} />;
{
/* Library only — select an agent to start */
}
-<TrueforgeUI server={server} layout="sidebar" agentConfig={{ mode: 'AgentLibrary' }} />;
+<TrueForgeUI server={server} layout="sidebar" agentConfig={{ mode: 'AgentLibrary' }} />;
{
/* Composer only */
}
-<TrueforgeUI
+<TrueForgeUI
server={server}
layout="sidebar"
agentConfig={{
@@ -456,10 +456,10 @@ function Layout({ className }: { className?: string }) {
);
}
-<TrueforgeUI server={server} layout={Layout} />;
+<TrueForgeUI server={server} layout={Layout} />;
```
-For deeper composition without `TrueforgeUI`, nest `SlotsProvider` outside `TrueFoundryChatProvider` — see [docs/customization.md](./docs/customization.md).
+For deeper composition without `TrueForgeUI`, nest `SlotsProvider` outside `TrueFoundryChatProvider` — see [docs/customization.md](./docs/customization.md).
> _Screenshot: a custom layout assembled from_ `BrandLogo`_,_ `ThreadListContainer`_, and_ `Thread`_._
@@ -470,7 +470,7 @@ For deeper composition without `TrueforgeUI`, nest `SlotsProvider` outside `True
Every curated feature atom is overridable. Provide an `overrides` map to swap any single component while inheriting the rest.
```tsx
-import { TrueforgeUI, type AssistantMessageBubbleProps } from '@truefoundry/trueforge-ui';
+import { TrueForgeUI, type AssistantMessageBubbleProps } from '@truefoundry/trueforge-ui';
function MyBubble({ children, error, actionBar, className }: AssistantMessageBubbleProps) {
return (
@@ -482,7 +482,7 @@ function MyBubble({ children, error, actionBar, className }: AssistantMessageBub
);
}
-<TrueforgeUI
+<TrueForgeUI
server={server}
layout="sidebar"
overrides={{
@@ -500,11 +500,11 @@ See [docs/customization.md](./docs/customization.md) for the full slot list.
## Server
-`<TrueforgeUI />` takes a **`TrueforgeServerConfig`**: built-in backends init
+`<TrueForgeUI />` takes a **`TrueForgeServerConfig`**: built-in backends init
inside the component, or pass a ready `AgentUIServer` directly.
```ts
-type TrueforgeServerConfig =
+type TrueForgeServerConfig =
| {
type: 'truefoundry';
apiKey: string;
@@ -539,7 +539,7 @@ host-owned: pass `token` and/or `fetch`.
**Compose your own `AgentUIServer` (custom):**
```tsx
-import { TrueforgeUI, createTrueFoundryServer } from '@truefoundry/trueforge-ui';
+import { TrueForgeUI, createTrueFoundryServer } from '@truefoundry/trueforge-ui';
import { createTrueFoundryChatServer } from '@truefoundry/assistant-ui-runtime/plugins/truefoundry-agent-server-adapter';
const chatServer = createTrueFoundryChatServer({ apiKey, baseUrl });
@@ -552,13 +552,13 @@ const agentServer = createTrueFoundryServer({
saveAgent,
});
-<TrueforgeUI server={agentServer} layout="sidebar" />;
+<TrueForgeUI server={agentServer} layout="sidebar" />;
```
**Implement `AgentUIServer` yourself:**
```tsx
-import { TrueforgeUI, type AgentUIServer } from '@truefoundry/trueforge-ui';
+import { TrueForgeUI, type AgentUIServer } from '@truefoundry/trueforge-ui';
const agentServer: AgentUIServer = {
// AgentChatServer methods…
@@ -576,7 +576,7 @@ const agentServer: AgentUIServer = {
saveAgent: async ({ agentName, agentSpec }) => ({ ok: true }),
};
-<TrueforgeUI server={agentServer} layout="sidebar" />;
+<TrueForgeUI server={agentServer} layout="sidebar" />;
```
See [docs/server.md](./docs/server.md) for the full method list and BYO guidance.
@@ -587,8 +587,8 @@ See [docs/server.md](./docs/server.md) for the full method list and BYO guidance
| Export | Kind | Purpose |
| ------------------------------------------------------------------ | ---------- | ------------------------------------------------------------ |
-| `TrueforgeUI` | Component | Root component — accepts all props above |
-| `TrueforgeServerConfig` | Type | `server` prop: `truefoundry` / `trueforge` / `AgentUIServer` |
+| `TrueForgeUI` | Component | Root component — accepts all props above |
+| `TrueForgeServerConfig` | Type | `server` prop: `truefoundry` / `trueforge` / `AgentUIServer` |
| `createTrueFoundryServer` | Function | Compose chat + builder into `AgentUIServer` |
| `Thread`, `ThreadListContainer`, `BrandLogo` | Components | Layout primitives for custom layouts |
| Composer / message / tool atoms | Components | Overridable, themeable building blocks |
diff --git a/packages/trueforge-ui/docs/api.md b/packages/trueforge-ui/docs/api.md
index 3748be884..287fb5e14 100644
--- a/packages/trueforge-ui/docs/api.md
+++ b/packages/trueforge-ui/docs/api.md
@@ -11,9 +11,9 @@ like `Button` / `IconButton` are styled via theme tokens / CSS (not
| Export | Notes |
| -------------------------------- | ------------------------------------------------------------------------------------ |
-| `TrueforgeUI` | Slots + runtime + built-in layout |
-| `TrueforgeUIProps`, `ChatLayout` | Props / layout union |
-| `TrueforgeServerConfig` | `server` prop: `type: "truefoundry"` \| `type: "trueforge"` \| ready `AgentUIServer` |
+| `TrueForgeUI` | Slots + runtime + built-in layout |
+| `TrueForgeUIProps`, `ChatLayout` | Props / layout union |
+| `TrueForgeServerConfig` | `server` prop: `type: "truefoundry"` \| `type: "trueforge"` \| ready `AgentUIServer` |
### Built-in servers
@@ -27,16 +27,16 @@ TrueForge hosts need `@truefoundry/trueforge-sdk`. Cookie apps pass `fetch`; emb
```tsx
// Harness / TrueForge
-<TrueforgeUI
+<TrueForgeUI
server={{ type: 'trueforge', baseUrl: '/', token: process.env.TRUEFORGE_TOKEN }}
layout="sidebar"
/>
// Or same-origin cookies:
-<TrueforgeUI server={{ type: 'trueforge', fetch: authAwareFetch }} layout="sidebar" />
+<TrueForgeUI server={{ type: 'trueforge', fetch: authAwareFetch }} layout="sidebar" />
```
-Factory without `<TrueforgeUI />`:
+Factory without `<TrueForgeUI />`:
```ts
import { createTrueForgeAgentUIServer } from '@truefoundry/trueforge-ui/plugins/trueforge-agent-server-adapter';
diff --git a/packages/trueforge-ui/docs/architecture.md b/packages/trueforge-ui/docs/architecture.md
index 6d8a65189..0b75d84de 100644
--- a/packages/trueforge-ui/docs/architecture.md
+++ b/packages/trueforge-ui/docs/architecture.md
@@ -40,7 +40,7 @@ function MyWelcome({ heading = 'Welcome' }: WelcomeScreenProps) {
```
Nested providers fall through to parent overrides, then `defaultSlots`.
-Quick start: `TrueforgeUI` mounts `SlotsProvider` outside the chat
+Quick start: `TrueForgeUI` mounts `SlotsProvider` outside the chat
provider. See [customization.md](./customization.md) for the keep-list.
## Theming
diff --git a/packages/trueforge-ui/docs/customization.md b/packages/trueforge-ui/docs/customization.md
index 35b8ed063..326a9b393 100644
--- a/packages/trueforge-ui/docs/customization.md
+++ b/packages/trueforge-ui/docs/customization.md
@@ -23,7 +23,7 @@ Prefer `theme={{ preset, mode, tokens, brand, icons, className, classNames }}`
over hacking third-party CSS:
```tsx
-<TrueforgeUI
+<TrueForgeUI
layout="sidebar"
theme={{
preset: 'claude',
@@ -88,7 +88,7 @@ function CenteredLayout({ className }: { className?: string }) {
);
}
-<TrueforgeUI layout={CenteredLayout} server={server} agentMode={…} />;
+<TrueForgeUI layout={CenteredLayout} server={server} agentMode={…} />;
```
## Restyle bubbles
diff --git a/packages/trueforge-ui/docs/server.md b/packages/trueforge-ui/docs/server.md
index 434890140..59dab5178 100644
--- a/packages/trueforge-ui/docs/server.md
+++ b/packages/trueforge-ui/docs/server.md
@@ -458,7 +458,7 @@ Typical builder → draft patch shape (not the full `AgentSpec`):
```
Host
└─ createTrueFoundryServer / custom AgentUIServer
-TrueforgeUI({ server, agentConfig, … })
+TrueForgeUI({ server, agentConfig, … })
├─ builder UI ──► server.getModels / getSkills / getMcp / saveAgent
└─ TrueFoundryChatProvider
└─ useTrueFoundryAgentRuntime({
@@ -494,7 +494,7 @@ clients and delegates `createSession` / `createDraftSession`.
### Phase 2 — Wire `server` into UI shell (named)
-1. Extend `TrueFoundryChatProvider` / `TrueforgeUI`:
+1. Extend `TrueFoundryChatProvider` / `TrueForgeUI`:
- prefer `server: AgentUIServer`
- keep legacy `client` or `apiKey` + `baseUrl` temporarily
2. When `server` is TFY-composed: resolve gateway clients → pass into existing
@@ -557,7 +557,7 @@ const server = createTrueFoundryServer({
searchAgents: async () => [],
});
-<TrueforgeUI
+<TrueForgeUI
server={server}
// omit agentConfig → AgentLibraryWithComposer (library + draft)
// agentConfig={{ mode: "SingleAgent", name: "my-agent" }}
@@ -623,7 +623,7 @@ import type {
AgentLibraryEntry,
} from '@truefoundry/trueforge-ui';
import {
- TrueforgeUI,
+ TrueForgeUI,
// TFY path still needs gateway clients for the unchanged runtime:
AgentSessionClient,
PrivateAgentSessionClient,
@@ -797,7 +797,7 @@ const server = createMyBackendServer({
export function App() {
return (
- <TrueforgeUI
+ <TrueForgeUI
server={server}
agentConfig={{
mode: 'AgentComposer',
diff --git a/packages/trueforge-ui/docs/theming.md b/packages/trueforge-ui/docs/theming.md
index c18e143fb..7f53d33da 100644
--- a/packages/trueforge-ui/docs/theming.md
+++ b/packages/trueforge-ui/docs/theming.md
@@ -262,7 +262,7 @@ function MyLayout({ className }: { className?: string }) {
);
}
-<TrueforgeUI
+<TrueForgeUI
layout={MyLayout} // or 'sidebar' | 'drawer' | 'dock' | 'widget'
theme={{
preset: 'claude',
@@ -361,7 +361,7 @@ precedence over `theme.icons.robot`. Preset-specific icons such as
## Layout override
-`TrueforgeUI` / chat shell `layout` prop:
+`TrueForgeUI` / chat shell `layout` prop:
| Value | Behavior |
| --------------------------------------------------- | ---------------------------- |
@@ -381,7 +381,7 @@ only the chrome tree is replaced. Equivalent to skipping built-in layouts
without dropping providers.
```tsx
-import { TrueforgeUI, Thread, ThreadListContainer } from '@truefoundry/trueforge-ui';
+import { TrueForgeUI, Thread, ThreadListContainer } from '@truefoundry/trueforge-ui';
function CenteredLayout() {
return (
@@ -392,7 +392,7 @@ function CenteredLayout() {
);
}
-<TrueforgeUI
+<TrueForgeUI
server={server}
agentConfig={{ mode: 'SingleAgent', name: 'my-agent' }}
layout={CenteredLayout}
@@ -432,14 +432,14 @@ Supported hooks are `markdown`, `inlineCode`,
`syntaxHighlighter.{root,pre,code,lineNumber}`,
`openui.{root,scope}`, and `monaco.{root,editor,monacoTheme}`.
-The standalone MCP OAuth callback selected by `TrueforgeUI` skips server
+The standalone MCP OAuth callback selected by `TrueForgeUI` skips server
resolution, but remains inside the same theme and slot provider boundary as the
main shell.
## Call flow
```
-TrueforgeUI({ layout, theme, overrides, … })
+TrueForgeUI({ layout, theme, overrides, … })
└─ SlotsProvider / ThemeProvider
├─ apply preset → CSS variables on .aui-root
├─ merge theme.tokens / brand / icons / classNames / className
diff --git a/packages/trueforge-ui/example/README.md b/packages/trueforge-ui/example/README.md
index f5067b638..c7d9eef45 100644
--- a/packages/trueforge-ui/example/README.md
+++ b/packages/trueforge-ui/example/README.md
@@ -50,7 +50,7 @@ the pnpm workspace root.
Open the URL Vite prints (usually `http://localhost:5173`).
-The demo uses `server={{ type: "truefoundry", … }}` so `<TrueforgeUI />` builds
+The demo uses `server={{ type: "truefoundry", … }}` so `<TrueForgeUI />` builds
the agent UI server from the control plane + API key (same path as production
TrueFoundry hosts). Pass `agentConfig` to pick shell mode (see `src/App.tsx`).
Default mode is **AgentLibraryWithComposer**. Change `VITE_TFY_AGENT_MODE` to
diff --git a/packages/trueforge-ui/example/src/App.tsx b/packages/trueforge-ui/example/src/App.tsx
index 433e7708f..edafb7a7c 100644
--- a/packages/trueforge-ui/example/src/App.tsx
+++ b/packages/trueforge-ui/example/src/App.tsx
@@ -8,7 +8,7 @@ import type {
DefinedSkill,
SkillCatalogEntry,
} from '@truefoundry/trueforge-ui';
-import { TrueforgeUI } from '@truefoundry/trueforge-ui';
+import { TrueForgeUI } from '@truefoundry/trueforge-ui';
function MissingEnv({ missing }: { missing: string[] }) {
return (
@@ -260,7 +260,7 @@ export default function App() {
return (
<div className="flex h-dvh min-h-0 w-full flex-1 flex-col">
- <TrueforgeUI
+ <TrueForgeUI
server={{
type: 'truefoundry',
apiKey,
diff --git a/packages/trueforge-ui/example/src/vite-env.d.ts b/packages/trueforge-ui/example/src/vite-env.d.ts
index ea01ffd25..409fe1f19 100644
--- a/packages/trueforge-ui/example/src/vite-env.d.ts
+++ b/packages/trueforge-ui/example/src/vite-env.d.ts
@@ -3,7 +3,7 @@
interface ImportMetaEnv {
readonly VITE_TFY_API_KEY: string;
readonly VITE_TFY_CONTROL_PLANE_URL: string;
- /** Optional — when omitted, TrueforgeUI resolves gateway from the control plane. */
+ /** Optional — when omitted, TrueForgeUI resolves gateway from the control plane. */
readonly VITE_TFY_GATEWAY_URL?: string;
readonly VITE_TFY_AGENT_NAME: string;
readonly VITE_TFY_AGENT_MODE?: string;
diff --git a/packages/trueforge-ui/src/containers/TrueforgeUI.tsx b/packages/trueforge-ui/src/containers/TrueforgeUI.tsx
index 8af97b1f0..fd868697e 100644
--- a/packages/trueforge-ui/src/containers/TrueforgeUI.tsx
+++ b/packages/trueforge-ui/src/containers/TrueforgeUI.tsx
@@ -9,7 +9,7 @@ import { cn } from '../atoms/lib/cn.js';
import { Spinner } from '../atoms/primitives/Spinner.js';
import { ServerProvider } from '../server/ServerContext.js';
import { DEFAULT_AGENT_CONFIG, ShellModeProvider, useShellMode, type AgentConfig } from '../server/ShellModeContext.js';
-import type { TrueforgeServerConfig } from '../server/TrueforgeServerConfig.js';
+import type { TrueForgeServerConfig } from '../server/TrueForgeServerConfig.js';
import { SlotsProvider, type SlotOverrides } from '../theme/SlotsProvider.js';
import type { LayoutProp, ThemeConfig } from '../theme/types.js';
import { getErrorMessage } from '../utils/getErrorMessage.js';
@@ -24,13 +24,13 @@ const WidgetLayout = lazy(() => import('../layouts/WidgetLayout.js').then(m => (
export type ChatLayout = 'sidebar' | 'drawer' | 'dock' | 'widget';
export type { AgentConfig } from '../server/ShellModeContext.js';
-export type { TrueforgeBuiltInServerConfig, TrueforgeServerConfig } from '../server/TrueforgeServerConfig.js';
+export type { TrueForgeBuiltInServerConfig, TrueForgeServerConfig } from '../server/TrueForgeServerConfig.js';
export type { LayoutProp } from '../theme/types.js';
type RuntimeAdapters = NonNullable<UseTrueFoundryAgentRuntimeOptions['adapters']>;
-export type TrueforgeUIProps = {
- server: TrueforgeServerConfig;
+export type TrueForgeUIProps = {
+ server: TrueForgeServerConfig;
/** Built-in layout string or a custom layout component. Defaults to `"sidebar"`. */
layout?: LayoutProp;
overrides?: SlotOverrides;
@@ -194,7 +194,7 @@ function ChatProviderFromShell({
* Quick-start assistant UI: slots + runtime + a built-in or custom layout.
* Pass a built-in `server` config, a ready `AgentUIServer`, and optional `agentConfig`.
*/
-export function TrueforgeUI(props: TrueforgeUIProps) {
+export function TrueForgeUI(props: TrueForgeUIProps) {
const isMcpAuthScreen =
typeof window !== 'undefined' && new URLSearchParams(window.location.search).get('screenType') === 'mcp-auth';
@@ -204,11 +204,11 @@ export function TrueforgeUI(props: TrueforgeUIProps) {
<PostMcpOauthScreen />
</SlotsProvider>
) : (
- <TrueforgeUIShell {...props} />
+ <TrueForgeUIShell {...props} />
);
}
-function TrueforgeUIShell(props: TrueforgeUIProps) {
+function TrueForgeUIShell(props: TrueForgeUIProps) {
const {
layout = 'sidebar',
overrides,
diff --git a/packages/trueforge-ui/src/containers/useResolvedServer.ts b/packages/trueforge-ui/src/containers/useResolvedServer.ts
index d830bebd2..5beb867a8 100644
--- a/packages/trueforge-ui/src/containers/useResolvedServer.ts
+++ b/packages/trueforge-ui/src/containers/useResolvedServer.ts
@@ -3,7 +3,7 @@
import { createTrueFoundryAgentUIServer } from '@truefoundry/assistant-ui-runtime/plugins/truefoundry-agent-server-adapter';
import { useEffect, useState } from 'react';
-import type { TrueforgeBuiltInServerConfig, TrueforgeServerConfig } from '../server/TrueforgeServerConfig.js';
+import type { TrueForgeBuiltInServerConfig, TrueForgeServerConfig } from '../server/TrueForgeServerConfig.js';
import type { AgentBuilderCapabilitiesResponse, AgentUIServer, CatalogServer } from '../server/types.js';
export type ResolvedServerState =
@@ -20,7 +20,7 @@ const DEFAULT_CAPABILITIES = {
},
} satisfies AgentBuilderCapabilitiesResponse;
-function isBuiltInConfig(config: TrueforgeServerConfig): config is TrueforgeBuiltInServerConfig {
+function isBuiltInConfig(config: TrueForgeServerConfig): config is TrueForgeBuiltInServerConfig {
return (
typeof config === 'object' &&
config !== null &&
@@ -45,7 +45,7 @@ function toAgentUIServer(server: object, catalog: CatalogServer | undefined): Ag
const withCapabilities = { ...server, getCapabilities };
const withCatalog = catalog != null ? { ...withCapabilities, catalog } : withCapabilities;
if (!isAgentUIServer(withCatalog)) {
- throw new Error('TrueforgeUI: runtime adapter returned an incomplete AgentUIServer');
+ throw new Error('TrueForgeUI: runtime adapter returned an incomplete AgentUIServer');
}
return withCatalog;
}
@@ -71,13 +71,13 @@ function isAgentUIServer(value: object): value is AgentUIServer {
}
/**
- * Resolves a {@link TrueforgeServerConfig} to an {@link AgentUIServer}.
+ * Resolves a {@link TrueForgeServerConfig} to an {@link AgentUIServer}.
* - `AgentUIServer` — sync passthrough
* - `truefoundry` — async via `createTrueFoundryAgentUIServer`
* - `trueforge` — via dynamic import of the Harness plugin adapter
*/
export function useResolvedServer(
- config: TrueforgeServerConfig,
+ config: TrueForgeServerConfig,
onError?: (error: unknown) => void,
): ResolvedServerState {
const builtIn = isBuiltInConfig(config) ? config : null;
diff --git a/packages/trueforge-ui/src/icons/registerAgentIcons.ts b/packages/trueforge-ui/src/icons/registerAgentIcons.ts
index 147ac6564..1e9592a5b 100644
--- a/packages/trueforge-ui/src/icons/registerAgentIcons.ts
+++ b/packages/trueforge-ui/src/icons/registerAgentIcons.ts
@@ -8,8 +8,8 @@ import BrainRegularIcon from './brain-regular.svg';
import CompareIcon from './compare.svg';
import McpServerIcon from './mcp-server.svg';
import SearchGlobeIcon from './search-globe.svg';
-import TrueforgeLogomarkDarkIcon from './trueforge-logomark-dark.svg';
-import TrueforgeLogomarkLightIcon from './trueforge-logomark-light.svg';
+import TrueForgeLogomarkDarkIcon from './trueforge-logomark-dark.svg';
+import TrueForgeLogomarkLightIcon from './trueforge-logomark-light.svg';
type SvgIcon = React.FC<React.SVGProps<SVGSVGElement>>;
@@ -20,6 +20,6 @@ registerIcons({
ai: AiIcon as unknown as SvgIcon,
searchGlobe: SearchGlobeIcon as unknown as SvgIcon,
'brain-regular': BrainRegularIcon as unknown as SvgIcon,
- 'trueforge-logomark-light': TrueforgeLogomarkLightIcon as unknown as SvgIcon,
- 'trueforge-logomark-dark': TrueforgeLogomarkDarkIcon as unknown as SvgIcon,
+ 'trueforge-logomark-light': TrueForgeLogomarkLightIcon as unknown as SvgIcon,
+ 'trueforge-logomark-dark': TrueForgeLogomarkDarkIcon as unknown as SvgIcon,
});
diff --git a/packages/trueforge-ui/src/index.ts b/packages/trueforge-ui/src/index.ts
index a8db05dac..f982c5620 100644
--- a/packages/trueforge-ui/src/index.ts
+++ b/packages/trueforge-ui/src/index.ts
@@ -175,13 +175,13 @@ export { ToolCallContainer } from './containers/ToolCallContainer.js';
export { ToolCallContentBlockContainer } from './containers/ToolCallContentBlockContainer.js';
export { ToolGroupContainer } from './containers/ToolGroupContainer.js';
export type { ThreadGroupPart } from './containers/ToolGroupContainer.js';
-export { TrueforgeUI } from './containers/TrueforgeUI.js';
+export { TrueForgeUI } from './containers/TrueForgeUI.js';
export type {
ChatLayout,
- TrueforgeBuiltInServerConfig,
- TrueforgeServerConfig,
- TrueforgeUIProps,
-} from './containers/TrueforgeUI.js';
+ TrueForgeBuiltInServerConfig,
+ TrueForgeServerConfig,
+ TrueForgeUIProps,
+} from './containers/TrueForgeUI.js';
export { TrueFoundryChatProvider } from './containers/TrueFoundryChatProvider.js';
export type { TrueFoundryChatProviderProps } from './containers/TrueFoundryChatProvider.js';
export { UserEditComposerContainer } from './containers/UserEditComposerContainer.js';
diff --git a/packages/trueforge-ui/src/plugins/trueforge-agent-server-adapter/index.ts b/packages/trueforge-ui/src/plugins/trueforge-agent-server-adapter/index.ts
index 37104379e..22f806734 100644
--- a/packages/trueforge-ui/src/plugins/trueforge-agent-server-adapter/index.ts
+++ b/packages/trueforge-ui/src/plugins/trueforge-agent-server-adapter/index.ts
@@ -1,5 +1,5 @@
/**
- * Built-in Harness → AgentUIServer factory for `<TrueforgeUI server={{ type: "trueforge", … }} />`.
+ * Built-in Harness → AgentUIServer factory for `<TrueForgeUI server={{ type: "trueforge", … }} />`.
*/
import { createTrueFoundryServer } from '../../server/createTrueFoundryServer.js';
import type { CatalogServer } from '../../server/types.js';
diff --git a/packages/trueforge-ui/src/server/TrueforgeServerConfig.ts b/packages/trueforge-ui/src/server/TrueforgeServerConfig.ts
index 32e30eeb5..6adc73c6b 100644
--- a/packages/trueforge-ui/src/server/TrueforgeServerConfig.ts
+++ b/packages/trueforge-ui/src/server/TrueforgeServerConfig.ts
@@ -1,10 +1,10 @@
import type { AgentUIServer, CatalogServer } from './types.js';
/**
- * Built-in backends init inside `<TrueforgeUI />`.
+ * Built-in backends init inside `<TrueForgeUI />`.
* Optional `catalog` is attached onto the resolved `AgentUIServer`.
*/
-export type TrueforgeBuiltInServerConfig =
+export type TrueForgeBuiltInServerConfig =
| {
type: 'truefoundry';
apiKey: string;
@@ -24,7 +24,7 @@ export type TrueforgeBuiltInServerConfig =
};
/**
- * `server` prop for `<TrueforgeUI />`: a built-in config, or a ready
+ * `server` prop for `<TrueForgeUI />`: a built-in config, or a ready
* {@link AgentUIServer} passed directly (no `{ type: "custom" }` wrapper).
*/
-export type TrueforgeServerConfig = TrueforgeBuiltInServerConfig | AgentUIServer;
+export type TrueForgeServerConfig = TrueForgeBuiltInServerConfig | AgentUIServer;
diff --git a/packages/trueforge-ui/test/containers/TrueforgeUI.test.tsx b/packages/trueforge-ui/test/containers/TrueforgeUI.test.tsx
index fd2e0e465..ec27f2baa 100644
--- a/packages/trueforge-ui/test/containers/TrueforgeUI.test.tsx
+++ b/packages/trueforge-ui/test/containers/TrueforgeUI.test.tsx
@@ -54,7 +54,7 @@ vi.mock('@/plugins/trueforge-agent-server-adapter/index.js', () => ({
),
}));
-import { TrueforgeUI, type ChatLayout } from '@/containers/TrueforgeUI.js';
+import { TrueForgeUI, type ChatLayout } from '@/containers/TrueForgeUI.js';
import { DrawerLayout } from '@/layouts/DrawerLayout.js';
import { SidebarLayout } from '@/layouts/SidebarLayout.js';
import { StackChatPanel } from '@/layouts/StackChatPanel.js';
@@ -81,13 +81,13 @@ beforeAll(() => {
};
});
-describe('TrueforgeUI', () => {
+describe('TrueForgeUI', () => {
const server = mockServer();
const layouts: ChatLayout[] = ['sidebar', 'drawer', 'dock', 'widget'];
it.each(layouts)('mounts layout=%s without crashing', async layout => {
const { container } = render(
- <TrueforgeUI
+ <TrueForgeUI
server={server}
agentConfig={{ mode: 'SingleAgent', name: 'my-agent' }}
layout={layout}
@@ -126,7 +126,7 @@ describe('TrueforgeUI', () => {
}
render(
- <TrueforgeUI
+ <TrueForgeUI
server={server}
agentConfig={{ mode: 'SingleAgent', name: 'my-agent' }}
layout={CustomLayout}
@@ -154,7 +154,7 @@ describe('TrueforgeUI', () => {
const getMcp = vi.fn(async () => []);
render(
- <TrueforgeUI
+ <TrueForgeUI
server={createMockAgentUIServer({ getCapabilities, getModels, getSkills, getMcp })}
agentConfig={{ mode: 'AgentComposer' }}
layout="sidebar"
@@ -195,7 +195,7 @@ describe('TrueforgeUI', () => {
const getSkills = vi.fn(async () => [{ id: 'research', name: 'Research' }]);
render(
- <TrueforgeUI
+ <TrueForgeUI
server={createMockAgentUIServer({ getModels, getMcp, getSkills })}
agentConfig={{ mode: 'AgentComposer' }}
layout="sidebar"
@@ -236,7 +236,7 @@ describe('TrueforgeUI', () => {
let unmount: (() => void) | undefined;
try {
const view = render(
- <TrueforgeUI
+ <TrueForgeUI
server={server}
agentConfig={{ mode: 'SingleAgent', name: 'my-agent' }}
layout={() => <div data-testid="regular-layout">regular chrome</div>}
@@ -254,7 +254,7 @@ describe('TrueforgeUI', () => {
});
it('resolves type trueforge and mounts the layout', async () => {
- render(<TrueforgeUI server={{ type: 'trueforge', token: 'tok' }} layout="sidebar" className="h-96" />);
+ render(<TrueForgeUI server={{ type: 'trueforge', token: 'tok' }} layout="sidebar" className="h-96" />);
await waitFor(() => {
expect(screen.queryByRole('status', { name: 'Loading' })).not.toBeInTheDocument();
@@ -264,7 +264,7 @@ describe('TrueforgeUI', () => {
it('shows a loader while truefoundry server init is pending', () => {
render(
- <TrueforgeUI
+ <TrueForgeUI
server={{
type: 'truefoundry',
apiKey: 'k',
diff --git a/packages/trueforge-ui/test/packageExports.smoke.mjs b/packages/trueforge-ui/test/packageExports.smoke.mjs
index 88c95619f..8042d04f9 100644
--- a/packages/trueforge-ui/test/packageExports.smoke.mjs
+++ b/packages/trueforge-ui/test/packageExports.smoke.mjs
@@ -50,7 +50,7 @@ const sdk = await import('@truefoundry/trueforge-ui');
const assistantUi = await import('@truefoundry/trueforge-ui/assistant-ui');
const trueforgeAdapter = await import('@truefoundry/trueforge-ui/plugins/trueforge-agent-server-adapter');
-assert.equal(typeof sdk.TrueforgeUI, 'function');
+assert.equal(typeof sdk.TrueForgeUI, 'function');
assert.equal(typeof sdk.createTrueFoundryServer, 'function');
assert.equal(typeof sdk.useMCPAuth, 'function');
assert.equal(typeof assistantUi.useAui, 'function');
diff --git a/packages/trueforge-ui/test/publicUiExports.test.ts b/packages/trueforge-ui/test/publicUiExports.test.ts
index 67852fb31..8fd9d6952 100644
--- a/packages/trueforge-ui/test/publicUiExports.test.ts
+++ b/packages/trueforge-ui/test/publicUiExports.test.ts
@@ -93,7 +93,7 @@ const expectedRuntimeExports: Array<keyof typeof sdk> = [
'ToolGroupCard',
'ToolGroupContainer',
'TrueFoundryChatProvider',
- 'TrueforgeUI',
+ 'TrueForgeUI',
'USER_MESSAGE_ATTACHMENT_PREVIEW_REM',
'UserEditComposerContainer',
'UserMessageActionBar',