caliper uidocs

Agent run

Pro

The full view of an agent task: steps, status, approvals and cost.

Installs components/ui/agent-run.tsxDepends on @radix-ui/react-slot, lucide-reactMotion none in component source
pnpm dlx shadcn@latest add @caliper/agent-run

When to use #

Use it for

  • Showing a long-running task the user can pause, stop or retry.
  • Some steps need approval.

Skip it when

  • The task is a single quick call; use the tool result.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/agent-run

Adds its 5 files to components/ui/, each with its own stylesheet, and installs their packages. Pro installs with your access token, set up once per project. See Pro access. The first part also adds Caliper UI’s tokens; import them once as in Installation.

Usage #

Import it from your copy of the source. The example behind the preview comes with the source.

example.tsx
import { AgentRun } from "@/components/ui/agent-run"

The worked example comes with Pro

The 67-line example behind the preview opens here with a Pro or Team licence.

Checking your licence…

API reference #

AgentRun

component
PropTypeDefaultDescription
run *AgentRunData—
onPause(() => void)—
onResume(() => void)—
onStop(() => void)—
onRetry(() => void)—
onApprove((stepId: string, approved: boolean) => void)—Called with the step id and the decision.
classNamestring—

Accessibility #

It exposes status semantics, with aria-label, aria-hidden, aria-current and aria-expanded kept in step with state. Changes that matter are announced through a live region.

No custom key handling; Tab and the native activation keys do the work.

Motion #

It declares no animation in its component source. Any transition comes from its stylesheet, which uses the duration tokens that collapse to instant under prefers-reduced-motion.