Skip to content
LogoLogo

Installation

Requirements

  • Node.js ≥ 18 for the core deployoor package and plugins
  • Node.js ≥ 20 for @deployoor/testing (tevm dependency)
  • A compiled Solidity project — Hardhat (artifacts/) or Foundry (out/)

Generated deployers are TypeScript (.ts). Run deploy scripts with tsx, Bun, or vitest — not bare node.

Install deployoor

pnpm add -D deployoor viem tsx
# or
npm install -D deployoor viem tsx

viem is a peer dependency — you bring your own version (≥ 2).

Scaffold config

npx deployoor init

This writes deployoor.config.ts if it does not exist.

Optional packages

PackageInstall when…
@deployoor/hardhatYou want deployers to regenerate on every hardhat compile
@deployoor/wagmi + @wagmi/cliYou want typed React hooks from deployments/
@deployoor/etherscanYou want explorer verification on deploy
@deployoor/sourcifyYou want Sourcify verification (keyless)
@deployoor/slackYou want Slack notifications on deploy
@deployoor/testingYou want in-memory EVM tests without a local node
pnpm add -D @deployoor/etherscan @deployoor/wagmi @wagmi/cli @deployoor/testing

Next steps

Quickstart →