arrow

Getting Started

Scaffold your first project, explore the workspace, and understand the core arrow workflow in under five minutes.

1

Create a project

Use arrow init to scaffold a new project. Choose from built-in templates or point to a custom template repository.

bash
arrow init my-app --template react

Available templates include react, vue, svelte, node, and rust. Add --ts for TypeScript variants.

2

Start the dev server

Change into the project directory and run the development server. Arrow watches your files and reloads the browser automatically.

bash
cd my-app && arrow dev
3

Build for production

When you are ready to ship, run the build command. Arrow optimises assets, bundles code, and writes the output to dist/.

bash
arrow build
4

Deploy

Deploy directly to the edge with a single command, or export static files to host anywhere.

bash
arrow deploy

Arrow supports Vercel, Netlify, Cloudflare Pages, and AWS out of the box.

Configuration

Arrow reads project settings from arrow.config.js or arrow.config.ts in the project root. A minimal config looks like this:

ts
export default {
  port: 3000,
  outDir: 'dist',
  plugins: ['@arrow/plugin-tailwind', '@arrow/plugin-sitemap'],
  deploy: {
    target: 'vercel',
    team: 'my-team',
  },
}

What's next?

  • Commands Reference — Explore every command, flag, and environment variable.
  • Examples — See real-world projects built with arrow.
  • Plugins — Extend arrow with plugins for databases, auth, and more.