Skip to content

Quick Start

Get a Cloudflare Worker running on a custom .test domain in under a minute.

Prerequisites

  • Corral installed with the privileged helper set up (see Installation)
  • A Cloudflare Workers or Pages project with a wrangler.toml or wrangler.json

Step 1: Register Your Project

CLI:

sh
corral project add ./my-worker

macOS App: Click the + button in the toolbar, or drag your project folder onto the main window.

Corral reads your wrangler.toml, detects the project type (Worker, Pages, or Durable Object), and parses all bindings and configuration.

Step 2: Start Everything

sh
corral up

This starts the infrastructure (DNS + reverse proxy) and any projects flagged for auto-start.

To start a specific project:

sh
corral start my-worker

Corral allocates a port, launches wrangler dev, waits for it to be ready, and registers the route with the proxy.

Step 3: Open Your Project

Visit your project in the browser:

https://my-worker.test

Corral routes the .test domain through DNS to the reverse proxy, which forwards the request to your running worker — with a valid HTTPS certificate.

You can also access it directly:

http://localhost:8787

Step 4: View Logs

Stream logs from all running projects:

sh
corral logs --follow

Or just one project:

sh
corral logs my-worker --follow

Step 5: Stop When You're Done

sh
corral down

This stops all running projects and shuts down the infrastructure.

Working with Multiple Projects

Corral really shines when you have several Workers:

sh
# Scan a directory to find all projects
corral project scan ~/code/cloudflare

# Start everything
corral up

# Each project gets its own subdomain:
#   api-worker.test
#   auth-service.test
#   frontend.test

Next Steps