🔐Create FHEVM Example CLI

The fastest way to bootstrap privacy-preserving dApps on FHEVM

🚀 One Command. Full Privacy. Zero Config.

Scaffold production-ready FHEVM projects in seconds. Pre-configured Hardhat, encrypted types, and comprehensive tests included.

---

⚡ Quick Start

Get started in under 30 seconds with our interactive wizard:

npm

npx create-fhevm-example

yarn

pnpm

bun

🎬 Watch the CLI in action — scaffold a project in seconds!

---

🎯 What You Get

⚡ Zero Configuration

Pre-configured hardhat.config.ts, FHE keys, network settings, and environment variables. Just run and build.

📚 33+ Ready Examples

From "Hello World" counters to advanced blind auctions and confidential tokens. Each with full test coverage.

🔌 Plug & Play

Create new projects OR inject FHE capabilities into your existing Hardhat projects with --add mode.

---

🎮 Three Powerful Modes

Choose the workflow that fits your needs:

1️⃣ Single Example Mode

Perfect for: Learning a specific FHE concept step-by-step.

# Interactive selection
npx create-fhevm-example

# Or directly specify the example
npx create-fhevm-example blind-auction

📋 What gets created?

A minimal, focused project with just one example:

my-blind-auction/
├── 📄 contracts/BlindAuction.sol    # The FHE smart contract
├── 🧪 test/BlindAuction.ts          # Full test suite
├── ⚙️ hardhat.config.ts             # Pre-configured for Zama
├── 📦 package.json                  # All dependencies included
└── 🔐 .env.example                  # Environment template

---

2️⃣ Category Bundle Mode

Perfect for: Exploring a domain like Gaming, OpenZeppelin, or Advanced patterns.

# Download all 5 Advanced examples at once
npx create-fhevm-example --category advanced

Available Categories:

Category	Examples	Description
🎓 Basic	11	Fundamentals: counters, encryption, decryption
💡 Concepts	8	Access control, handles, input proofs, edge cases, anti-patterns
🎮 Gaming	4	Poker, lottery, rock-paper-scissors, blackjack
🏛️ OpenZeppelin	5	ERC7984, wrappers, swaps, vesting
🎯 Advanced	6	Blind auction, escrow, voting, KYC, payroll, order book

---

3️⃣ Smart Injection Mode (--add)

Requirement: Run this inside an existing Hardhat project directory.

Already have a project? Upgrade it to FHE in one command:

cd my-existing-project
npx create-fhevm-example --add

What happens:

1. ✅ Detects your Hardhat configuration

2. ✅ Adds @fhevm/solidity and @fhevm/hardhat-plugin

3. ✅ Updates hardhat.config.ts with FHE imports

4. ✅ Injects a sample contract and test of your choice

🔧 Adding FHE to an existing Hardhat project

---

⌨️ CLI Options

Option	Description
--example <name>	Create a single example project
--category <name>	Create a category project
--add	Add FHEVM to existing Hardhat project
--target <dir>	Target directory for --add mode
--output <dir>	Output directory
--help	Show help message

---

🏗️ Project Structure

Every scaffolded project follows this clean, minimal structure:

my-fhevm-project/
│
├── 📂 contracts/           # Solidity contracts
│   └── MyContract.sol      # Your FHE-enabled contract
│
├── 📂 test/                # TypeScript tests
│   ├── types.ts            # Shared type definitions
│   └── MyContract.ts       # Mocha/Chai test suite
│
├── ⚙️ hardhat.config.ts    # Hardhat + FHEVM configuration
├── 📦 package.json         # Dependencies and scripts
├── 📄 .env.example         # Environment variable template
└── 📖 README.md            # Project-specific documentation

---

🎬 Next Steps

After scaffolding, get your project running:

1

Install Dependencies

npm install

2

Compile Contracts

npm run compile

3

Run Tests

npm run test

4

Start Building! 🚀

Open contracts/ and start writing your privacy-preserving logic!

---

❓ Frequently Asked Questions

Does this work with existing Hardhat projects?

Yes! Use the --add flag inside your project directory. The CLI will detect your Hardhat setup and inject FHE dependencies automatically.

cd my-existing-project
npx create-fhevm-example --add

Do I need to install anything globally?

No! Just use npx (comes with Node.js). The CLI runs directly without any global installation.

What Node.js version is required?

Node.js v20.0.0 or higher is required. We recommend using the latest LTS version.

Can I use this offline?

Yes! All example files are bundled in the package. Scaffolding works fully offline — only npm install requires internet to download dependencies.

How do I run tests after scaffolding?

Simply run these commands in your new project:

npm install
npm run compile
npm run test

What networks are supported?

Projects are pre-configured for:

• Local (Hardhat Network with FHEVM mock)

• Zama Devnet (Sepolia-based testnet)

You can add more networks in hardhat.config.ts.

---

📚 Learn More

📖 FHEVM Documentation

Deep dive into Fully Homomorphic Encryption on the blockchain. docs.zama.org/protocol/

💻 GitHub Repository

Star us, report issues, or contribute! github.com/NecipAkgz/fhevm-example-factory

Need Help? Join the Zama Discord community for support and discussions!