Skip to main content

Documentation Index

Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Guides

Each guide helps you complete one goal with the Veryfront library or CLI. Pick the guide that matches what you want to do next. If you are new, start at Get started and walk through the guides in order. If you already have a project, jump to the section that matches your goal.

Get started

GuideWhat you will do
InstallationInstall the Veryfront CLI and framework on macOS, Linux, or Windows.
QuickstartInstall Veryfront, create a project, and run the dev server.
Create an agentDefine an agent and invoke it from server code in under five minutes.
Choose a primitivePick the smallest Veryfront primitive that matches the work.
Production pathBuild one route from local project to production verification.
Project structureLearn the file conventions and how auto-discovery wires your project up.
ConfigurationConfigure veryfront.config.ts, environment variables, and runtime settings.

Build pages and APIs

GuideWhat you will do
Pages and routingAdd file-based pages, layouts, dynamic routes, and MDX content.
Data fetchingLoad data on the server, prerender static pages, and fetch from the client.
API routesBuild HTTP handlers with request parsing and streaming responses.
MiddlewareAdd CORS, rate limiting, logging, and custom middleware pipelines.
Head and SEOSet page metadata, Open Graph tags, and structured data.

Add an AI agent

GuideWhat you will do
ProvidersPick a model provider for local inference, Veryfront Cloud, or a direct vendor.
AgentsDefine an agent with a system prompt, tools, and memory.
Agent service runtimeRun agents as separately deployed services.
ToolsDefine typed tools that agents can call.
Memory and streamingAdd conversation memory and stream model output to the client.

Build a chat UI

GuideWhat you will do
Chat UIDrop in the preset chat component with one hook and one API route.
Chat compositionBuild a custom chat layout with the composition components.
Chat hooksDrive chat from headless hooks: chat, agent, completion, voice, and thread.
Chat themingTheme chat features, attachments, sources, models, and visuals.

Orchestrate work across agents and time

GuideWhat you will do
WorkflowsDefine a DAG-based workflow with branches, retries, and parallel steps.
Multi-agentCompose agents with delegation and agent-as-tool patterns.
SkillsAdd project-level skills from SKILL.md files with tool restrictions.
JobsRun one-off jobs, schedule cron jobs, and inspect batch summaries.
TasksWrite background task functions that run locally or as cloud jobs.

Connect external systems

GuideWhat you will do
MCP serverExpose tools, prompts, and resources over Model Context Protocol.
OAuthSign users in with OAuth 2.0 and the built-in provider catalog.
IntegrationsWire config-driven integration tools with OAuth, token management, and API execution.
SandboxRun isolated commands and file operations in an ephemeral sandbox session.
CLI knowledge ingestionTurn uploads and local documents into project knowledge files from the CLI.

Extend Veryfront

GuideWhat you will do
ExtensionsUnderstand how extensions add focused capabilities to a Veryfront project.
Extension authoringWrite a focused extension factory, contract, and capability.
Extension lifecycleTrace extension discovery, ordering, setup, and teardown.
Extension testingTest an extension factory and the contracts it implements.
Extension publishingPackage and publish a reusable extension.

Ship to production

GuideWhat you will do
Production pathFollow the shortest route from dev server to production checks.
Building and deployingBuild for production, configure static export, and pick a host.