Config Options

Configuration options for Khizab CLI.

contracts

ContractConfig[] | undefined

Array of contracts to use when running commands. abi and name are required, all other properties are optional.

Abi

ABI for contract. Used by plugins to generate code base on properties.

khizab.config.ts

export default {
  out: 'src/generated.ts',
  contracts: [
    {
      abi: { … },
      name: 'MyCoolContract'
    },
  ],
}

export default {
  out: 'src/generated.ts',
  contracts: [
    {
      abi: { … },
      name: 'MyCoolContract'
    },
  ],
}

string

Name of contract. Must be unique. Used by plugins to name generated code.

khizab.config.ts

export default {
  out: 'src/generated.ts',
  contracts: [
    {
      abi: { … },
      name: 'MyCoolContract'
    },
  ],
}

export default {
  out: 'src/generated.ts',
  contracts: [
    {
      abi: { … },
      name: 'MyCoolContract'
    },
  ],
}

string

Path to output generated code. Must be unique per config. Use an Array Config for multiple outputs.

khizab.config.ts

export default {
  out: 'src/generated.ts',
  contracts: [
    {
      abi: { … },
      name: 'MyCoolContract'
    },
  ],
}

export default {
  out: 'src/generated.ts',
  contracts: [
    {
      abi: { … },
      name: 'MyCoolContract'
    },
  ],
}

Plugin[] | undefined

Plugins to use and their configuration.

Khizab CLI has multiple built-in plugins that are used to manage ABIs, generate code, etc.

khizab.config.ts

import { react } from '@khizab/cli/plugins'

export default {
  out: 'src/generated.js',
  plugins: [
    react(),
  ],
}

import { react } from '@khizab/cli/plugins'

export default {
  out: 'src/generated.js',
  plugins: [
    react(),
  ],
}