forked from farhoodlabs/paperclip
ab8b471685
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies, so adapter quality directly affects what runtimes the control plane can supervise. > - Local CLI adapters are one of the core execution surfaces because they turn real coding tools into Paperclip-managed employees with heartbeats, transcripts, and reviewability. > - Grok Build was installed on the Paperclip host, but Paperclip had no built-in `grok_local` adapter, so the runtime could not be configured through the normal server/UI/CLI adapter path. > - That gap needed to be closed with the same built-in registry, environment diagnostics, transcript parsing, and skill/instructions behavior that the other local adapters already rely on. > - After the initial adapter landed, a real follow-up run showed that Grok streaming text was being rendered one fragment per line, which made transcripts harder to read even though the runtime itself was working. > - This pull request adds the built-in `grok_local` adapter end-to-end and then fixes the transcript parser so streamed Grok output is coalesced into readable assistant/thinking blocks. > - The benefit is that Grok Build becomes a first-class Paperclip runtime with a usable operator experience instead of a partially wired runtime with noisy transcript output. ## What Changed - Added a new built-in `@paperclipai/adapter-grok-local` package with server, UI, and CLI entrypoints. - Implemented Grok execution, session handling, environment diagnostics, config building, skill syncing, and parser coverage inside the new adapter package. - Registered `grok_local` across the built-in adapter inventories and capability/display metadata in server, UI, CLI, and shared constants. - Added adapter route coverage for the new built-in type. - Fixed Grok transcript readability by emitting streamed `text` and `thought` fragments as deltas so the shared transcript builder coalesces them into readable message blocks. - Added regression tests for the Grok parser and transcript coalescing behavior. ## Verification - `pnpm vitest run packages/adapters/grok-local/src/ui/parse-stdout.test.ts ui/src/adapters/transcript.test.ts` - `pnpm --filter @paperclipai/adapter-grok-local build` - Manual runtime verification on the Paperclip host during implementation and follow-up review: - confirmed the Grok CLI was installed and authenticated - confirmed the worktree dev server could be restarted cleanly and health-checked after the parser follow-up - No screenshots attached. This change is primarily adapter plumbing plus transcript formatting behavior; reviewers can verify via the Grok-backed run surfaces directly. ## Risks - This adds a new built-in adapter, so any missed registration surface could create inconsistencies between server, UI, and CLI behavior. - The adapter depends on Grok Build's current event/output shape; if upstream Grok streaming JSON changes, transcript parsing or session extraction may need follow-up updates. - The transcript readability fix intentionally changes how Grok fragments are grouped, so any downstream code that implicitly expected one entry per fragment would behave differently. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - OpenAI Codex via Paperclip `codex_local` agent runtime. - GPT-5-class coding model with tool use, shell execution, file editing, and repo inspection enabled. - Exact backend model ID/context window were not surfaced to the agent in this Paperclip session. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [ ] If this change affects the UI, I have included before/after screenshots - [ ] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] I will address all Greptile and reviewer comments before requesting merge
177 lines
4.6 KiB
TypeScript
177 lines
4.6 KiB
TypeScript
/**
|
|
* Single source of truth for adapter display metadata.
|
|
*
|
|
* Built-in adapters have entries in `adapterDisplayMap`. External (plugin)
|
|
* adapters get sensible defaults derived from their type string via
|
|
* `getAdapterDisplay()`.
|
|
*/
|
|
import type { ComponentType } from "react";
|
|
import {
|
|
Bot,
|
|
Code,
|
|
Gem,
|
|
MousePointer2,
|
|
Sparkles,
|
|
Terminal,
|
|
Cpu,
|
|
} from "lucide-react";
|
|
import { OpenCodeLogoIcon } from "@/components/OpenCodeLogoIcon";
|
|
import { HermesIcon } from "@/components/HermesIcon";
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Type suffix parsing
|
|
// ---------------------------------------------------------------------------
|
|
|
|
const TYPE_SUFFIXES: Record<string, string> = {
|
|
_local: "local",
|
|
_gateway: "gateway",
|
|
};
|
|
|
|
function getTypeSuffix(type: string): string | null {
|
|
for (const [suffix, mode] of Object.entries(TYPE_SUFFIXES)) {
|
|
if (type.endsWith(suffix)) return mode;
|
|
}
|
|
return null;
|
|
}
|
|
|
|
function withSuffix(label: string, suffix: string | null): string {
|
|
return suffix ? `${label} (${suffix})` : label;
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Display metadata per adapter type
|
|
// ---------------------------------------------------------------------------
|
|
|
|
export interface AdapterDisplayInfo {
|
|
label: string;
|
|
description: string;
|
|
icon: ComponentType<{ className?: string }>;
|
|
recommended?: boolean;
|
|
comingSoon?: boolean;
|
|
disabledLabel?: string;
|
|
experimental?: boolean;
|
|
hideFromVisualSelection?: boolean;
|
|
}
|
|
|
|
const adapterDisplayMap: Record<string, AdapterDisplayInfo> = {
|
|
acpx_local: {
|
|
label: "ACPX",
|
|
description: "Experimental local ACPX multi-agent adapter",
|
|
icon: Bot,
|
|
experimental: true,
|
|
hideFromVisualSelection: true,
|
|
},
|
|
claude_local: {
|
|
label: "Claude Code",
|
|
description: "Local Claude agent",
|
|
icon: Sparkles,
|
|
recommended: true,
|
|
},
|
|
codex_local: {
|
|
label: "Codex",
|
|
description: "Local Codex agent",
|
|
icon: Code,
|
|
recommended: true,
|
|
},
|
|
gemini_local: {
|
|
label: "Gemini CLI",
|
|
description: "Local Gemini agent",
|
|
icon: Gem,
|
|
},
|
|
grok_local: {
|
|
label: "Grok Build",
|
|
description: "Local Grok Build agent",
|
|
icon: Bot,
|
|
},
|
|
opencode_local: {
|
|
label: "OpenCode",
|
|
description: "Local multi-provider agent",
|
|
icon: OpenCodeLogoIcon,
|
|
},
|
|
hermes_local: {
|
|
label: "Hermes Agent",
|
|
description: "Local Hermes CLI agent",
|
|
icon: HermesIcon,
|
|
},
|
|
pi_local: {
|
|
label: "Pi",
|
|
description: "Local Pi agent",
|
|
icon: Terminal,
|
|
},
|
|
cursor: {
|
|
label: "Cursor",
|
|
description: "Local Cursor agent",
|
|
icon: MousePointer2,
|
|
},
|
|
cursor_cloud: {
|
|
label: "Cursor Cloud",
|
|
description: "Managed remote Cursor agent",
|
|
icon: MousePointer2,
|
|
},
|
|
openclaw_gateway: {
|
|
label: "OpenClaw Gateway",
|
|
description: "Invoke OpenClaw via gateway protocol",
|
|
icon: Bot,
|
|
comingSoon: true,
|
|
disabledLabel: "Configure OpenClaw within the App",
|
|
},
|
|
process: {
|
|
label: "Process",
|
|
description: "Internal process adapter",
|
|
icon: Cpu,
|
|
comingSoon: true,
|
|
},
|
|
http: {
|
|
label: "HTTP",
|
|
description: "Internal HTTP adapter",
|
|
icon: Cpu,
|
|
comingSoon: true,
|
|
},
|
|
};
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Public API
|
|
// ---------------------------------------------------------------------------
|
|
|
|
function humanizeType(type: string): string {
|
|
// Strip known type suffixes so "droid_local" → "Droid", not "Droid Local"
|
|
let base = type;
|
|
for (const suffix of Object.keys(TYPE_SUFFIXES)) {
|
|
if (base.endsWith(suffix)) {
|
|
base = base.slice(0, -suffix.length);
|
|
break;
|
|
}
|
|
}
|
|
return base.replace(/_/g, " ").replace(/\b\w/g, (c) => c.toUpperCase());
|
|
}
|
|
|
|
export function getAdapterLabel(type: string): string {
|
|
const base = adapterDisplayMap[type]?.label ?? humanizeType(type);
|
|
return withSuffix(base, getTypeSuffix(type));
|
|
}
|
|
|
|
export function getAdapterLabels(): Record<string, string> {
|
|
const suffixed: Record<string, string> = {};
|
|
for (const [type, info] of Object.entries(adapterDisplayMap)) {
|
|
suffixed[type] = withSuffix(info.label, getTypeSuffix(type));
|
|
}
|
|
return suffixed;
|
|
}
|
|
|
|
export function getAdapterDisplay(type: string): AdapterDisplayInfo {
|
|
const known = adapterDisplayMap[type];
|
|
if (known) return known;
|
|
|
|
const suffix = getTypeSuffix(type);
|
|
const label = withSuffix(humanizeType(type), suffix);
|
|
return {
|
|
label,
|
|
description: suffix ? `External ${suffix} adapter` : "External adapter",
|
|
icon: Cpu,
|
|
};
|
|
}
|
|
|
|
export function isKnownAdapterType(type: string): boolean {
|
|
return type in adapterDisplayMap;
|
|
}
|