Skip to main content

​
Prerequisites

  • The Veryfront CLI installed (see Installation).
  • A terminal in which you can run veryfront init.

​
Scaffold

veryfront init test-app
cd test-app
Choose minimal for a blank app or ai-agent for an agent and chat route. Pass --template to skip the prompt: 
veryfront init test-app --template ai-agent

​
Choose a runtime

By default, veryfront init scaffolds projects for Node.js. Pass --runtime <node|bun|deno> to select a different JavaScript runtime: 
veryfront init test-app --template ai-agent --runtime bun
veryfront init test-app --template ai-agent --runtime deno
What this changes:
  • All runtimes get the same package.json and template files.
  • --runtime deno additionally writes a thin deno.json so deno task dev / deno task build / deno task preview work without extra setup. Deno reads npm dependencies directly from package.json via nodeModulesDir: "auto".
  • The install command and the printed next-steps match your runtime (npm install / bun install / deno install).
You can also set "runtime": "deno" in the JSON file passed to --config.

​
Use a package manager

Use these commands when you do not have the Veryfront CLI installed globally. 
npm create veryfront

​
Run the dev server

veryfront dev
Open http://localhost:3000. File changes reload the browser.

​
Inspect the scaffold

The minimal template creates: 
test-app/
  app/
    layout.tsx      # Root layout wrapping all pages
    page.tsx        # Home page (/)
    about/
      page.mdx      # /about (MDX page)
  package.json
  README.md
The ai-agent template also creates: 
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/. The agent template also adds root-level agents/ and tools/. For the convention behind these directories, see Framework conventions.

​
Verify it worked

veryfront dev prints Ready on http://localhost:3000. Open the URL and save a source file. The browser should hot-reload.