Config reference

defineConfig from deployoor types your deployoor.config.ts.

import { defineConfig } from "deployoor";
 
export default defineConfig({
  include?: string[];
  out?: string;
  deploymentsPath?: string;
  plugins?: Plugin[];
  onPluginError?: "warn" | "throw";
});

include

Contract names to generate deployers for. Default: every contract in artifacts that has deployable bytecode.

If a name in include matches nothing, deployoor generate warns (typo or compile failure).

out

Directory for generated deployers. Default: ./deployers.

deploymentsPath

Directory for JSON deployment records. Default: ./deployments.

plugins

Array of plugin instances from @deployoor/etherscan, @deployoor/slack, or your own definePlugin exports.

onPluginError

• "warn" (default) — log plugin failure, still write the deployment record
• "throw" — fail the run on plugin error

Generated exports

deployoor generate writes, per contract:

• getOrDeploy<Name> — idempotent deployer
• Typed artifact module for each contract
• Project-level register and reset bound to your config