Skip to content
On this page

czg --config

Synopsis

czg --config=<file path> - Specify the configuration file to use

Description

czg will automatically configure the current project root path or $HOME path of the configuration file
But if you need to specify path a configuration file, you can use this option


e.g: czg --config="./config/cz.json"

json
// config/cz.json
{
  "$schema": "https://cdn.jsdelivr.net/gh/Zhengqbbb/cz-git@1.9.1/docs/public/schema/cz-git.json",
  "maxSubjectLength": 100
  // configure ...
}
// config/cz.json
{
  "$schema": "https://cdn.jsdelivr.net/gh/Zhengqbbb/cz-git@1.9.1/docs/public/schema/cz-git.json",
  "maxSubjectLength": 100
  // configure ...
}

e.g czg --config="./config/cz.js"

js
// config/cz.js
/** @type {import('czg').CommitizenGitOptions} */
module.exports = {
  maxSubjectLength: 100
  // configure ...
}
// config/cz.js
/** @type {import('czg').CommitizenGitOptions} */
module.exports = {
  maxSubjectLength: 100
  // configure ...
}

TIP

czg supports configuration item. ⇒ see the configuration guide
czg default configure. ⇒ see the configuration template

I just try my best to make thing well, Could you give a star ⭐