Skip to content

Package Overview

IntentForm is split into small, focused packages. Install only what you need.

PackageExportsInstall when
@intentform/corecreateIntentForm, engine runtime, model registry, rule evaluatorAlways — the core engine
@intentform/sharedShared TypeScript types (ModelDefinition, FieldDefinition, Rule, AiProvider, etc.)When defining models in a separate file or package
PackageExportsInstall when
@intentform/react<IntentForm />, useIntentForm, useIntentFormEngineAny React app that renders the intent input + form
PackageExportsPeer depInstall when
@intentform/adapter-tanstack-formtanstackAdapter()@tanstack/react-formGreenfield — recommended for new projects
@intentform/adapter-react-hook-formrhfAdapter()react-hook-formMigrating an existing RHF codebase

Both adapters are optional. Without one, IntentForm uses its built-in uncontrolled renderer.

PackageExportsModel defaultInstall when
@intentform/provider-openaiopenaiProvider()gpt-4o-miniUsing OpenAI (most common)
@intentform/provider-anthropicanthropicProvider()claude-sonnet-4-6Using Anthropic
@intentform/provider-googlegoogleProvider()gemini-2.0-flashUsing Google (cheapest fast tier)
@intentform/provider-ollamaollamaProvider()llama3.2Local/offline inference (dev/testing)

See AI Providers for per-provider guidance.

PackageExportsInstall when
@intentform/servercreateIntentFormHonoRoute, createIntentFormNextHandler, createIntentFormServerFn, createIntentFormRouteYour backend is Node.js (Hono, Next.js, TanStack Start, or generic Web Fetch)
@intentform/server-httpStandalone HTTP server (CLI + Docker image)Your backend is non-Node (Spring, .NET, Python, etc.)
@intentform/clientcreateClientIntentForm()Browser client that talks to an @intentform/server or @intentform/server-http endpoint

See Server-Side Architecture for when to use each pattern.

PackageExportsInstall when
@intentform/debug-ui<IntentFormDebugPanel />Development — inspect confidence, model selection, field relevance
@intentform/testTest helpers and vitest matchersWriting unit/integration tests for your models and rules