@an-sdk/cli 0.0.8 → 0.0.10

package/docs/02-getting-started.md

@@ -0,0 +1,110 @@
+# Getting Started
+
+## 1. Get an API Key
+
+Sign up at [an.dev](https://an.dev) and get your API key from [an.dev/agents/dashboard/api](https://an.dev/agents/dashboard/api).
+
+## 2. Install
+
+```bash
+npm install @an-sdk/agent zod
+```
+
+## 3. Define Your Agent
+
+Create `src/agent.ts`:
+
+```ts
+import { agent, tool } from "@an-sdk/agent"
+import { z } from "zod"
+
+export default agent({
+  model: "claude-sonnet-4-6",
+  systemPrompt: "You are a helpful coding assistant.",
+  tools: {
+    greet: tool({
+      description: "Greet a user by name",
+      inputSchema: z.object({ name: z.string() }),
+      execute: async ({ name }) => ({
+        content: [{ type: "text", text: `Hello, ${name}!` }],
+      }),
+    }),
+  },
+})
+```
+
+## 4. Login & Deploy
+
+```bash
+npx @an-sdk/cli login
+# Enter your API key: an_sk_...
+
+npx @an-sdk/cli deploy
+# Bundling src/agent.ts...
+# Deploying my-agent...
+# https://api.an.dev/v1/chat/my-agent
+```
+
+Your agent is live.
+
+## 5. Embed in a React App
+
+```bash
+npm install @an-sdk/nextjs @an-sdk/react ai @ai-sdk/react
+```
+
+Create a token route (keeps your API key on the server):
+
+```ts
+// app/api/an/token/route.ts
+import { createAnTokenHandler } from "@an-sdk/nextjs/server"
+
+export const POST = createAnTokenHandler({
+  apiKey: process.env.AN_API_KEY!,
+})
+```
+
+Add the chat UI:
+
+```tsx
+// app/page.tsx
+"use client"
+
+import { useChat } from "@ai-sdk/react"
+import { AnAgentChat, createAnChat } from "@an-sdk/nextjs"
+import "@an-sdk/react/styles.css"
+import { useMemo } from "react"
+
+export default function Chat() {
+  const chat = useMemo(
+    () => createAnChat({
+      agent: "your-agent-slug",
+      tokenUrl: "/api/an/token",
+    }),
+    [],
+  )
+
+  const { messages, sendMessage, status, stop, error } = useChat({ chat })
+
+  return (
+    <AnAgentChat
+      messages={messages}
+      onSend={(msg) =>
+        sendMessage({ parts: [{ type: "text", text: msg.content }] })
+      }
+      status={status}
+      onStop={stop}
+      error={error}
+    />
+  )
+}
+```
+
+## Next Steps
+
+- [Defining Agents](./03-defining-agents.md) — Models, tools, hooks, permissions
+- [React UI](./04-react-ui.md) — Theming, slots, tool renderers
+- [Next.js Integration](./05-nextjs.md) — Server-side token handler
+- [Node SDK](./06-node-sdk.md) — Sandboxes, threads, tokens from server code
+- [CLI Reference](./07-cli.md) — All CLI commands
+- [Custom Tools](./08-custom-tools.md) — Build custom tool renderers

package/docs/03-defining-agents.md

@@ -0,0 +1,159 @@
+# Defining Agents
+
+Agents are defined with the `agent()` and `tool()` functions from `@an-sdk/agent`. These are config-only — they return exactly what you pass in, with type inference added. The actual execution happens in the AN runtime (E2B sandbox).
+
+## `agent(config)`
+
+```ts
+import { agent } from "@an-sdk/agent"
+
+export default agent({
+  // Model (default: "claude-sonnet-4-6")
+  model: "claude-sonnet-4-6",
+
+  // System prompt
+  systemPrompt: "You are a PR reviewer...",
+
+  // Custom tools (see below)
+  tools: { /* ... */ },
+
+  // Runtime: "claude-code" (default) or "codex"
+  runtime: "claude-code",
+
+  // Permission mode: "default", "acceptEdits", or "bypassPermissions"
+  permissionMode: "default",
+
+  // Max conversation turns (default: 50)
+  maxTurns: 50,
+
+  // Max budget in USD
+  maxBudgetUsd: 5,
+
+  // Lifecycle hooks (see below)
+  onStart: async () => {},
+  onToolCall: async ({ toolName, input }) => {},
+  onToolResult: async ({ toolName, input, output }) => {},
+  onStepFinish: async ({ step }) => {},
+  onFinish: async ({ result }) => {},
+  onError: async ({ error }) => {},
+})
+```
+
+### Defaults
+
+| Field | Default |
+|-------|---------|
+| `model` | `"claude-sonnet-4-6"` |
+| `runtime` | `"claude-code"` |
+| `permissionMode` | `"default"` |
+| `maxTurns` | `50` |
+| `tools` | `{}` |
+
+## `tool(definition)`
+
+```ts
+import { tool } from "@an-sdk/agent"
+import { z } from "zod"
+
+const myTool = tool({
+  description: "What this tool does",
+  inputSchema: z.object({
+    path: z.string(),
+    verbose: z.boolean().optional(),
+  }),
+  execute: async (args) => {
+    // args is fully typed: { path: string; verbose?: boolean }
+    return {
+      content: [{ type: "text", text: "result" }],
+    }
+  },
+})
+```
+
+The `execute` function receives args typed from the Zod schema. Return value must have `content` array with `{ type: "text", text: string }` items.
+
+## Hooks
+
+### `onToolCall`
+
+Runs before a tool executes. Return `false` to block it.
+
+```ts
+onToolCall: async ({ toolName, input }) => {
+  if (toolName === "Bash" && input.command?.includes("rm -rf")) {
+    return false // blocked
+  }
+}
+```
+
+### `onToolResult`
+
+Runs after a tool executes with the result.
+
+```ts
+onToolResult: async ({ toolName, input, output }) => {
+  console.log(`Tool ${toolName} returned:`, output)
+}
+```
+
+### `onFinish`
+
+Runs when the agent completes successfully.
+
+```ts
+onFinish: async ({ result }) => {
+  await fetch("https://my-api.com/webhook", {
+    method: "POST",
+    body: JSON.stringify({ done: true }),
+  })
+}
+```
+
+### `onError`
+
+Runs when the agent encounters an error.
+
+```ts
+onError: async ({ error }) => {
+  console.error("Agent failed:", error)
+}
+```
+
+## Permission Modes
+
+| Mode | Behavior |
+|------|----------|
+| `"default"` | Agent asks for confirmation on risky operations |
+| `"acceptEdits"` | Auto-approve file edits, still confirm other actions |
+| `"bypassPermissions"` | Auto-approve everything (use with caution) |
+
+## Type Reference
+
+```ts
+// Agent config (all fields required — defaults filled by agent())
+interface AgentConfig {
+  model: string
+  systemPrompt: string
+  tools: ToolSet
+  runtime: "claude-code" | "codex"
+  permissionMode: "default" | "acceptEdits" | "bypassPermissions"
+  maxTurns: number
+  maxBudgetUsd?: number
+  onStart?: () => Promise<void>
+  onToolCall?: (payload: { toolName: string; input: any }) => Promise<boolean | void>
+  onToolResult?: (payload: { toolName: string; input: any; output: any }) => Promise<void>
+  onStepFinish?: (payload: { step: any }) => Promise<void>
+  onFinish?: (payload: { result: any }) => Promise<void>
+  onError?: (payload: { error: Error }) => Promise<void>
+}
+
+// Tool definition — generic over Zod schema
+interface ToolDefinition<TInput> {
+  description: string
+  inputSchema: ZodType<TInput>
+  execute: (args: TInput) => Promise<{ content: { type: string; text: string }[] }>
+}
+
+// Tool set
+type ToolSet = Record<string, ToolDefinition<any>>
+```

package/docs/04-react-ui.md

@@ -0,0 +1,186 @@
+# React UI
+
+`@an-sdk/react` provides a full chat UI for AN agents. Built on [Vercel AI SDK v5](https://sdk.vercel.ai) — uses standard `useChat()` from `@ai-sdk/react`.
+
+## Install
+
+```bash
+npm install @an-sdk/react ai @ai-sdk/react
+```
+
+## Basic Usage
+
+```tsx
+"use client"
+
+import { useChat } from "@ai-sdk/react"
+import { AnAgentChat, createAnChat } from "@an-sdk/react"
+import "@an-sdk/react/styles.css"
+import { useMemo } from "react"
+
+export default function Chat() {
+  const chat = useMemo(
+    () => createAnChat({
+      agent: "your-agent-slug",
+      getToken: async () => "your_an_sk_token",
+    }),
+    [],
+  )
+
+  const { messages, sendMessage, status, stop, error } = useChat({ chat })
+
+  return (
+    <AnAgentChat
+      messages={messages}
+      onSend={(msg) =>
+        sendMessage({ parts: [{ type: "text", text: msg.content }] })
+      }
+      status={status}
+      onStop={stop}
+      error={error}
+    />
+  )
+}
+```
+
+## `createAnChat(options)`
+
+Creates an AI SDK `Chat` instance pointed at the AN Relay.
+
+```ts
+createAnChat({
+  agent: string              // Agent slug from dashboard
+  getToken: () => Promise<string>  // Returns an_sk_ key or JWT
+  apiUrl?: string            // Default: "https://relay.an.dev"
+  projectId?: string         // Session persistence key
+  onFinish?: () => void
+  onError?: (error: Error) => void
+})
+```
+
+For Next.js apps, use `tokenUrl` instead of `getToken` — see [Next.js Integration](./05-nextjs.md).
+
+## `<AnAgentChat />` Props
+
+| Prop | Type | Description |
+|------|------|-------------|
+| `messages` | `UIMessage[]` | From `useChat()` |
+| `onSend` | `(msg) => void` | Send handler |
+| `status` | `ChatStatus` | `"ready" \| "submitted" \| "streaming" \| "error"` |
+| `onStop` | `() => void` | Stop generation |
+| `error` | `Error` | Error to display |
+| `theme` | `AnTheme` | Theme from playground |
+| `colorMode` | `"light" \| "dark" \| "auto"` | Color mode |
+| `classNames` | `Partial<AnClassNames>` | Per-element CSS overrides |
+| `slots` | `Partial<AnSlots>` | Component swapping |
+| `className` | `string` | Root element class |
+| `style` | `CSSProperties` | Root element style |
+
+## Customization
+
+Four levels, from simple to full control:
+
+### 1. Theme tokens
+
+Apply a theme JSON from the [AN Playground](https://an.dev/an/playground):
+
+```tsx
+<AnAgentChat theme={playgroundTheme} colorMode="dark" />
+```
+
+### 2. Class overrides
+
+```tsx
+<AnAgentChat
+  classNames={{
+    root: "rounded-2xl border",
+    messageList: "px-8",
+    inputBar: "bg-gray-50",
+    userMessage: "bg-blue-100",
+  }}
+/>
+```
+
+### 3. Slot components
+
+Swap sub-components:
+
+```tsx
+<AnAgentChat
+  slots={{
+    InputBar: MyCustomInput,
+    UserMessage: MyUserBubble,
+    ToolRenderer: MyToolRenderer,
+  }}
+/>
+```
+
+### 4. Individual component imports
+
+```tsx
+import { MessageList, InputBar, ToolRenderer } from "@an-sdk/react"
+```
+
+## CSS
+
+Import once in your app:
+
+```tsx
+import "@an-sdk/react/styles.css"
+```
+
+No Tailwind peer dependency — CSS is pre-compiled. All elements have stable `an-*` class names:
+
+```css
+.an-root { }
+.an-message-list { }
+.an-user-message { }
+.an-assistant-message { }
+.an-input-bar { }
+.an-send-button { }
+.an-tool-bash { }
+.an-tool-edit { }
+```
+
+## Theme Type
+
+```ts
+interface AnTheme {
+  theme: Record<string, string>  // Shared: font, spacing, accent
+  light: Record<string, string>  // Light mode CSS vars
+  dark: Record<string, string>   // Dark mode CSS vars
+}
+```
+
+## `applyTheme(element, theme, colorMode?)`
+
+Manually inject CSS variables from a theme JSON onto a DOM element.
+
+## Components
+
+| Component | Description |
+|-----------|-------------|
+| `MessageList` | Auto-scrolling message container with grouping |
+| `UserMessage` | User message bubble |
+| `AssistantMessage` | Assistant response with parts routing |
+| `StreamingMarkdown` | Markdown renderer with syntax highlighting |
+| `InputBar` | Text input with send/stop buttons |
+| `MessageActions` | Copy button |
+| `ToolRenderer` | Routes tool parts to the correct component |
+
+## Built-in Tool Renderers
+
+| Component | Renders |
+|-----------|---------|
+| `BashTool` | Terminal commands with output |
+| `EditTool` | File edits with diff display |
+| `WriteTool` | File creation |
+| `SearchTool` | Web search results |
+| `TodoTool` | Task checklists |
+| `PlanTool` | Step-by-step plans |
+| `TaskTool` | Sub-agent tasks |
+| `McpTool` | MCP protocol calls |
+| `ThinkingTool` | Reasoning/thinking indicator |
+| `GenericTool` | Fallback for unknown tools |
+
+See [Custom Tools](./08-custom-tools.md) for building your own tool renderers.

package/docs/05-nextjs.md

@@ -0,0 +1,117 @@
+# Next.js Integration
+
+`@an-sdk/nextjs` provides a server-side token handler so your `an_sk_` API key never reaches the browser. It also re-exports everything from `@an-sdk/react` for convenience.
+
+## Install
+
+```bash
+npm install @an-sdk/nextjs @an-sdk/react ai @ai-sdk/react
+```
+
+## Setup
+
+### 1. Set your API key
+
+```env
+# .env.local
+AN_API_KEY=an_sk_your_key_here
+```
+
+Get your API key from [an.dev/agents/dashboard/api](https://an.dev/agents/dashboard/api).
+
+### 2. Create the token route
+
+```ts
+// app/api/an/token/route.ts
+import { createAnTokenHandler } from "@an-sdk/nextjs/server"
+
+export const POST = createAnTokenHandler({
+  apiKey: process.env.AN_API_KEY!,
+})
+```
+
+### 3. Use in your page
+
+```tsx
+// app/page.tsx
+"use client"
+
+import { useChat } from "@ai-sdk/react"
+import { AnAgentChat, createAnChat } from "@an-sdk/nextjs"
+import "@an-sdk/react/styles.css"
+import { useMemo } from "react"
+
+export default function Chat() {
+  const chat = useMemo(
+    () => createAnChat({
+      agent: "your-agent-slug",
+      tokenUrl: "/api/an/token",
+    }),
+    [],
+  )
+
+  const { messages, sendMessage, status, stop, error } = useChat({ chat })
+
+  return (
+    <AnAgentChat
+      messages={messages}
+      onSend={(msg) =>
+        sendMessage({ parts: [{ type: "text", text: msg.content }] })
+      }
+      status={status}
+      onStop={stop}
+      error={error}
+    />
+  )
+}
+```
+
+## How It Works
+
+```
+Browser                     Your Next.js Server              AN Relay
+  |                                |                            |
+  |-- POST /api/an/token --------->|                            |
+  |                                |-- POST /v1/tokens -------->|
+  |                                |   (with an_sk_ key)        |
+  |                                |<-- { token, expiresAt } ---|
+  |<-- { token, expiresAt } ------|                            |
+  |                                                             |
+  |-- POST /v1/chat/:agent ------(with short-lived JWT)------->|
+  |<-- streaming response -----(SSE)---------------------------|
+```
+
+The client only receives short-lived JWTs. Your API key stays on the server.
+
+## API
+
+### `createAnTokenHandler(options)`
+
+Returns a Next.js `POST` route handler.
+
+```ts
+createAnTokenHandler({
+  apiKey: string       // Your an_sk_ API key
+  relayUrl?: string    // Default: "https://relay.an.dev"
+  expiresIn?: string   // Default: "1h"
+})
+```
+
+### `exchangeToken(options)`
+
+Lower-level function for custom token exchange logic.
+
+```ts
+import { exchangeToken } from "@an-sdk/nextjs/server"
+
+const { token, expiresAt } = await exchangeToken({
+  apiKey: process.env.AN_API_KEY!,
+  relayUrl: "https://relay.an.dev",
+  expiresIn: "1h",
+})
+```
+
+## Entry Points
+
+- `@an-sdk/nextjs` — Re-exports everything from `@an-sdk/react` (components, types, `createAnChat`)
+- `@an-sdk/nextjs/server` — Server-only: `createAnTokenHandler`, `exchangeToken`

package/docs/06-node-sdk.md

@@ -0,0 +1,125 @@
+# Node SDK
+
+`@an-sdk/node` is a server-side client for the AN API. Use it to manage sandboxes, threads, and tokens programmatically.
+
+## Install
+
+```bash
+npm install @an-sdk/node
+```
+
+## Quick Start
+
+```ts
+import { AnClient } from "@an-sdk/node"
+
+const an = new AnClient({
+  apiKey: process.env.AN_API_KEY!, // an_sk_...
+})
+
+// Create a sandbox for your agent
+const sandbox = await an.sandboxes.create({ agent: "my-agent" })
+
+// Create a thread
+const thread = await an.threads.create({
+  sandboxId: sandbox.sandboxId,
+  name: "Review PR #42",
+})
+
+// Generate a short-lived token for browser clients
+const { token, expiresAt } = await an.tokens.create({
+  agent: "my-agent",
+  expiresIn: "1h",
+})
+```
+
+## `AnClient`
+
+```ts
+new AnClient({
+  apiKey: string     // Your an_sk_ API key
+  baseUrl?: string   // Default: "https://relay.an.dev"
+})
+```
+
+## Resources
+
+### `client.sandboxes`
+
+| Method | Description |
+|--------|-------------|
+| `create({ agent })` | Create a new sandbox for an agent |
+| `get(sandboxId)` | Get sandbox details (status, threads, agent info) |
+| `delete(sandboxId)` | Delete a sandbox |
+
+### `client.threads`
+
+| Method | Description |
+|--------|-------------|
+| `list({ sandboxId })` | List all threads in a sandbox |
+| `create({ sandboxId, name? })` | Create a new thread |
+| `get({ sandboxId, threadId })` | Get thread with messages |
+| `delete({ sandboxId, threadId })` | Delete a thread |
+
+### `client.tokens`
+
+| Method | Description |
+|--------|-------------|
+| `create({ agent?, userId?, expiresIn? })` | Create a short-lived JWT |
+
+Default `expiresIn` is `"1h"`.
+
+## Types
+
+```ts
+interface Sandbox {
+  id: string
+  sandboxId: string
+  status: string
+  createdAt: string
+}
+
+interface SandboxDetail {
+  id: string
+  sandboxId: string
+  status: string
+  error?: string | null
+  agent: { slug: string; name: string }
+  threads: ThreadSummary[]
+  createdAt: string
+  updatedAt: string
+}
+
+interface ThreadSummary {
+  id: string
+  name?: string | null
+  status: string
+  createdAt: string
+}
+
+interface Thread {
+  id: string
+  name?: string | null
+  status: string
+  messages?: unknown
+  createdAt: string
+  updatedAt: string
+}
+
+interface Token {
+  token: string
+  expiresAt: string
+}
+```
+
+## Error Handling
+
+All methods throw on non-2xx responses. The error message comes from the API response body when available.
+
+```ts
+try {
+  const sandbox = await an.sandboxes.get("nonexistent")
+} catch (err) {
+  console.error(err.message) // "Sandbox not found" or similar
+}
+```