Quick Start

Deploy Keyflare to your Cloudflare account in minutes

Quick Start

Get Keyflare running on your Cloudflare account in just a few commands.

Prerequisites

Node.js

Node.js 20+ installed on your machine.

Cloudflare Account

A Cloudflare account. Free tier works perfectly. You need to be able to create at least one more Worker and one D1 database.

Installation

Install the Keyflare CLI globally:

npm install -g @keyflare/cli

Or use it directly with npx:

npx @keyflare/cli init

Optional: Use the bundled agent skill

If you use an AI coding agent in this repo, Keyflare ships with a lightweight CLI usage skill at:

.agents/skills/keyflare/SKILL.md

It is focused on day-to-day commands (projects, environments, secrets, keys, and kfl run).

Deploy Keyflare

Run the initialization command:

kfl init

You’ll be prompted to authenticate with Cloudflare:

Browser (OAuth)

Opens cloudflare.com in your browser. Wrangler caches the OAuth session locally, so subsequent runs reuse the session automatically.

API Token

Generate a token at Cloudflare Dashboard with these permissions:

• Workers Scripts:Edit
• D1:Edit
• Workers Routes:Edit

Or set CLOUDFLARE_API_TOKEN in your environment to skip the prompt (CI-friendly).

What kfl init Does

1. Authenticate

   Checks for existing Wrangler session or prompts for authentication method.

2. Deploy Worker

   Deploys the Keyflare Worker to your Cloudflare account via wrangler deploy.

3. Create Database

   Wrangler auto-provisions the D1 database from the configuration.

4. Set Master Key

   Generates a 256-bit MASTER_KEY and stores it as a Worker secret.

5. Apply Database Schema

   Runs Drizzle migrations to create the database schema.

6. Bootstrap

   Creates the first root user key via the /bootstrap endpoint.

7. Save Configuration

   Saves the API URL and root key to ~/.config/keyflare/.

Save your master key! If lost, all encrypted data becomes permanently unrecoverable.

Next Steps

Now that Keyflare is deployed, you can:

Create a Project

Organize your secrets into projects and environments.

Add Secrets

Store your first secrets in Keyflare.

Create API Keys

Generate scoped keys for CI/CD and services.