Home/Docs/Quickstart

Quickstart

Deploy your first Worker, add a domain, and connect an origin — all in about five minutes.

Before you begin

You'll need a Benediction account and a domain you control. The free plan covers everything in this guide.

You can follow along without a domain by using the *.benediction.site development zone. We provision one automatically.

1 · Install the CLI

The gitflare CLI is a single static binary. Install it with the following command, or download a release from the CLI reference.

curl -fsSL https://install.benediction.site/cli.sh | sh
# → installed /usr/local/bin/gitflare (v1.34.2)

gitflare --version
gitflare version 1.34.2 (edge, linux/amd64)

2 · Authenticate

Log in with your account. The CLI stores a short-lived token in ~/.config/gitflare/credentials.json; API tokens never touch disk.

gitflare login
# opens your browser, then:
✓ authenticated as maya@example.com (org: northwind-labs)

3 · Deploy your first Worker

Workers run on the edge in 40+ languages. Scaffold a project, write a handler, and deploy — the bundler handles dependencies for you.

// src/index.js
export default {
  async fetch(request, env) {
    const url = new URL(request.url);
    if (url.pathname === "/hello") {
      return new Response("Hello from the edge!", {
        headers: { "Cache-Control": "public, max-age=60" },
      });
    }
    return new Response("Not found", { status: 404 });
  },
};
gitflare workers deploy ./src/index.js --name hello-edge
# ✓ built bundle (412 B, 1 dependency)
# ✓ deployed to 280+ locations in 1.4s
# ✓ live at https://hello-edge.benediction.site

Test it:

curl -sI https://hello-edge.benediction.site/hello | head -5
# HTTP/2 200
# content-type: text/plain;charset=UTF-8
# cf-ray: atl1-19923

4 · Add your domain

Onboarding a domain is one command. We'll show you the two records to add at your registrar; propagation usually completes in minutes.

gitflare zones add example.com
# 1.  Create a CNAME record:  example.com  →  edge.benediction.site
# 2.  Create a TXT record:    _gitflare    →  verif=8f3a... (optional, for DNSSEC)
# ✓ zone active in 96s

gitflare zones list
# example.com    ACTIVE   DNSSEC on   TLS auto  1.0.0.1

5 · Connect an origin

Already have a site? Add an origin rule so /api/* traffic goes to your server while static assets stay on the edge.

gitflare origins add \
  --zone example.com \
  --pattern "/api/*" \
  --target https://origin.example.com
# ✓ origin rule created · TLS verify on · keep-alive enabled

Next steps