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.

​
Quickstart

Create and run a Veryfront project in under 2 minutes. The flow below starts locally and ends with an optional Veryfront Cloud deploy. The same project can also run self-hosted or on other infrastructure. The npm package, CLI, and import name remain veryfront.

​
Prerequisites

  • The current Node.js LTS, with npm, pnpm, or yarn on your PATH.
  • A terminal in which you can run global npm install (use npx veryfront if global installs aren’t possible).

​
Install

npm install -g veryfront

​
Create a project

veryfront init test-app
cd test-app
The CLI walks you through template selection. The current templates are:
Template IDLabelWhat you get
minimalMinimalBlank canvas, no extras
ai-agentAI AgentAgent + chat UI + streaming
docs-agentDocs AgentDocument Q&A with source citations
agentic-workflowAgentic WorkflowSteps + approvals + parallelism
multi-agent-systemMulti-Agent SystemAgents that delegate to each other
coding-agentCoding AgentAI code assistant with file tools
saas-starterSaaS StarterAuth + chat + per-user memory
To skip the prompt and pick a template up front, pass --template: 
veryfront init test-app --template ai-agent

​
Start the dev server

veryfront dev
Open http://localhost:3000. Changes to any file reload instantly.

​
Project overview

After init with the minimal template, your project looks like this: 
test-app/
  app/
    layout.tsx      # Root layout wrapping all pages
    page.tsx        # Home page (/)
    about/
      page.mdx      # /about (MDX page)
  package.json
  README.md
If you picked the ai-agent template, you also get: 
test-app/
  agents/
    assistant.ts    # AI agent definition
  tools/
    calculator.ts   # Tool the agent can call
  app/
    layout.tsx
    page.tsx        # Chat UI
    api/
      ag-ui/
        route.ts    # AG-UI streaming chat endpoint
Pages live in app/. Agents, tools, prompts, and workflows live at the project root: they’re auto-discovered by the framework.

​
Build for production

veryfront build
veryfront start

​
Deploy

veryfront deploy
Deploys to Veryfront Cloud, the recommended managed deployment path. Your site is live at https://<slug>.production.veryfront.com. If you prefer a different deployment target, run veryfront build and deploy the generated output using your own infrastructure.

​
Verify it worked

After veryfront dev, the terminal prints Ready on http://localhost:3000. Open that URL: the template’s home page should render and a Cmd+S save in any source file should hot-reload within a second.

​
Next