Skip to content

configuration-reference.md

Latest commit

 

History

History
128 lines (82 loc) · 2.2 KB

configuration-reference.md

File metadata and controls

128 lines (82 loc) · 2.2 KB

Configuration Reference

CodeHawk CLI configuration is stored in .codehawk.yaml.

General settings

language

Set the language for reviews by using the corresponding ISO language code.

Type: string

Default: en-US

Allowed values:

de, de-DE, de-AT, de-CH, en, en-US, en-AU, en-GB, en-CA, en-NZ, en-ZA,
es, es-AR, fr, fr-CA, fr-CH, fr-BE, nl, nl-BE, pt-AO, pt, pt-BR, pt-MZ,
pt-PT, ar, ast-ES, ast, be-BY, be, br-FR, br, ca-ES, ca, ca-ES-valencia,
ca-ES-balear, da-DK, da, de-DE-x-simple-language, el-GR, el, eo, fa,
ga-IE, ga, gl-ES, gl, it, ja-JP, ja, km-KH, km, ko-KR, ko, pl-PL, pl,
ro-RO, ro, ru-RU, ru, sk-SK, sk, sl-SI, sl, sv, ta-IN, ta, tl-PH, tl,
tr, uk-UA, uk, zh-CN, zh, crh-UA, crh, cs-CZ, cs, nb, no, nl-NL,
de-DE-x-simple-language-DE, es-ES, it-IT, fa-IR, sv-SE, de-LU, fr-FR,
bg-BG, bg, he-IL, he, hi-IN, hi, vi-VN, vi, th-TH, th, bn-BD, bn

Example:

language: zh-CN

tone_instructions

Set the tone of reviews and chat.

Type: string

Default: ""

Max length: 250

Example:

tone_instructions: "You must talk like Mr. T. I pity the fool who doesn't!"

Review

profile

Set the review profile: chill for lighter feedback, assertive for more feedback, which may feel nitpicky.

Type: enum

Default: chill

Allowed values:

chill, assertive

Example:

review:
  profile: assertive

high_level_summary

Generate a high-level summary of the changes in the PR description or walkthrough.

Type: boolean

Default: true

Example:

review:
  high_level_summary: true

poem

Generate a poem in the walkthrough comment.

Type: boolean

Default: true

Example:

review:
  poem: true

path_instructions

Add path-specific guidance for code review.

Type: array of object

Default: []

Array item fields:

Field Type Description
path string File path glob pattern. Example: **/*.js.
instructions string Additional review guidance for matching paths. Max length: 20000.

Example:

review:
  path_instructions:
    - path: "**/*.go"
      instructions: "Focus on error handling, concurrency bugs, and missing tests."