docs

Guides

Focused, navigation-friendly walkthroughs for building with @hec-ovi/agentickit. Each page is self-contained: open the one matching your task, copy the snippets, ship.

The root README is the marketing-and-overview page. These guides are the "I'm in the editor, now what" pages.

Read in this order if you're new

1. Getting started - install, minimal Next/Bun example, run it locally
2. The three hooks - usePilotState, usePilotAction, usePilotForm
3. Chat surfaces - <PilotSidebar>, <PilotPopup>, <PilotModal>, <PilotChatView>
4. Server handler - createPilotHandler, the .pilot/ skills protocol, the CLI

Reach for these when the task asks

5. Runtimes and multi-agent - swap localRuntime for agUiRuntime; route to one of many agents
6. Human-in-the-loop - confirm modal for mutating actions, renderAndWait for pause-and-resume
7. Providers - the supported AI SDK adapters; vLLM-specific gotchas (live-verified)
8. Testing - the mocked fetch harness, the live vLLM gate, what to assert

What's NOT in here

• API surface reference. Use TypeScript and your editor's hover, or read packages/agentickit/src/types.ts directly. Types are the contract.
• Phase history. The CHANGELOG is the running log.
• Generative UI internals. See PilotAgentStateView source; the test file alongside it is a good worked example.

House rules

• Compact, opinionated, code-first. If a page is more than a screen of prose, something is wrong.
• Examples are real. Every snippet here is structurally close to something in packages/agentickit/src/ or examples/todo/.
• We update these alongside the code. If a guide claims something the source no longer does, file an issue.