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.

​
Installation

Install the veryfront CLI and framework so you can scaffold, run, and build Veryfront projects. Most users want the Quickstart flow that follows. The install methods below all produce the same veryfront CLI; pick the one that matches your toolchain.

​
Prerequisites

  • A terminal with shell access (bash, zsh, or PowerShell).
  • One of the supported runtimes installed (see System requirements).
  • Network access:
    • Binary installer (curl, PowerShell, Homebrew): reachable hosts include veryfront.com (installer script), api.github.com (release metadata), and github.com (binary download from the veryfront/veryfront releases page).
    • npm / npx: access to your configured npm registry (default registry.npmjs.org).

​
System requirements

Veryfront ships as a standalone binary and as an npm package. Pick the rows that match how you plan to install it.

​
Operating system

OSBinary installernpm / npx
macOS 12 or later (Intel and Apple Silicon)Yes (curl or Homebrew)Yes
Linux x86_64 and arm64 (glibc)Yes (curl or Homebrew)Yes
Windows 10 or later, x86_64 and arm64Yes (PowerShell install.ps1)Yes

​
Runtime

RuntimeMinimum versionNotes
Node.js18.18Required for npm, npx, and the framework runtime.
Deno1.45Optional; supports running the framework directly.
Bun1.1Optional; supports running the framework directly.

​
Hardware

  • 1 GB of free disk space for the CLI, framework, and node_modules.
  • 2 GB of RAM for development; 4 GB or more is recommended when running an AI agent locally.

​
Supported browsers

Veryfront renders React Server Components and ships modern ES2022 client bundles. The built-in chat UI, router, and head components are tested against the latest two stable releases of:
  • Chrome and Chromium-based browsers (Edge, Brave, Arc, Opera)
  • Firefox
  • Safari (macOS 14 and iOS 16 or later)
Older browsers may work but are not part of the supported matrix.

​
Install

Pick the method that matches your toolchain. All five produce the same veryfront CLI; the tabs below give you the one-liner, and the sections that follow add detail and version-pinning options. 
curl -fsSL https://veryfront.com/install.sh | sh

​
curl (standalone binary, macOS and Linux)

curl -fsSL https://veryfront.com/install.sh | sh
Installs the latest standalone binary to ~/.veryfront/bin/veryfront. Recommended for macOS and Linux when you mainly use the CLI and TUI. Pin a version or change the install directory: 
curl -fsSL https://veryfront.com/install.sh | sh -s -- --version 0.1.0 --dir /usr/local/bin

​
PowerShell (standalone binary, Windows)

irm https://veryfront.com/install.ps1 | iex
Installs the latest standalone binary to %USERPROFILE%\.veryfront\bin\veryfront.exe. Supports Windows 10 or later on x86_64 and arm64. Pin a version or change the install directory: 
& ([scriptblock]::Create((irm https://veryfront.com/install.ps1))) -Version 0.1.0 -Dir C:\Tools\veryfront

​
Homebrew

brew install veryfront/tap/veryfront
Same binary as the curl installer, managed by Homebrew. Works on macOS and Linux.

​
npm (project scaffolder)

npm create veryfront
Creates a new project using create-veryfront. The same command works with the other Node-compatible package managers: 
pnpm create veryfront
yarn create veryfront
bun create veryfront
deno init --npm veryfront

​
npx (one-shot)

npx veryfront
Runs the latest veryfront CLI without installing it globally. Useful for trying commands or one-off scripts in CI.

​
Verify it worked

veryfront --version
You should see the installed version printed. If the command is not found after a fresh install, restart your shell so the new PATH entry takes effect. On Windows, run the same command in PowerShell or in a new terminal session so the updated PATH is picked up.

​
Next

  • Quickstart: create and run your first Veryfront project in under two minutes.
  • Project structure: learn the conventions the CLI scaffolds.
  • Configuration: wire up environment variables and runtime options.