docs: document config file search paths by ivy · Pull Request #701 · jdx/hk

ivy · 2026-02-21T21:02:01Z

Hey jdx! 👋 I was sprucing up my dotfiles and wanted to see how hk loads its configs. This PR adds some details similar to your docs covering mise.toml search paths.

Also, I ran into an issue that made it difficult to double-check hk fix --all (did my best to follow CONTRIBUTING.md):

❯ mise install
mise ERROR communique not found in mise tool registry

🤖 Conversation log (for transparency)

List all supported config file paths and their precedence order, the directory walk-up behavior, and differences from mise's config resolution for users coming from that tool. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

gemini-code-assist · 2026-02-21T21:02:12Z

Summary of Changes

Hello @ivy, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the hk documentation by providing a clear explanation of how configuration files are located and prioritized. It aims to improve user understanding of hk's configuration loading mechanism, including local overrides and the absence of config file merging, making it easier for users to manage their project configurations.

Highlights

Documentation Update: Added a new section to the configuration.md documentation detailing the search order and precedence for hk configuration files (hk.pkl, hk.local.pkl).
Configuration Behavior Clarification: Clarified that hk does not merge multiple config files and uses Pkl's amends mechanism for local overrides, contrasting it with mise.

Changelog

docs/configuration.md
- Added a new "Config File Paths" section.
- Included a table outlining the search precedence for hk.local.pkl and hk.pkl.
- Clarified that hk walks up the directory tree to find config files.
- Mentioned the HK_FILE environment variable for overriding the search.
- Added a note explaining hk's config merging behavior compared to mise.

Activity

The author encountered a mise install error (communique not found) while testing, which was mentioned in the PR description.
A conversation log was provided for transparency.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request adds valuable documentation about how hk searches for configuration files. The new 'Config File Paths' section is clear and accurately reflects the implementation, which will be very helpful for users. I have one minor suggestion to further improve the clarity of the precedence table.

ivy · 2026-02-21T21:03:18Z

Wow, Gemini's fast! Might have to give that a try sometime!

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [hk](https://github.com/jdx/hk) | minor | `1.36.0` → `1.38.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>jdx/hk (hk)</summary> ### [`v1.38.0`](https://github.com/jdx/hk/blob/HEAD/CHANGELOG.md#1380---2026-03-06) [Compare Source](jdx/hk@v1.37.0...v1.38.0) ##### 🚀 Features - **(hook)** add `fail_on_fix` option by [@jdx](https://github.com/jdx) in [#725](jdx/hk#725) ##### 🐛 Bug Fixes - **(builtins)** remove redundant check/check\_diff from builtins by [@nkakouros](https://github.com/nkakouros) in [#726](jdx/hk#726) ##### 📦️ Dependency Updates - update anthropics/claude-code-action digest to [`26ec041`](jdx/hk@26ec041) by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#720](jdx/hk#720) - update jdx/mise-action digest to [`e79ddf6`](jdx/hk@e79ddf6) by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#721](jdx/hk#721) - update actions-rust-lang/setup-rust-toolchain digest to [`a0b538f`](jdx/hk@a0b538f) by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#719](jdx/hk#719) - update rust crate tokio to v1.50.0 by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#722](jdx/hk#722) ### [`v1.37.0`](https://github.com/jdx/hk/blob/HEAD/CHANGELOG.md#1370---2026-03-03) [Compare Source](jdx/hk@v1.36.0...v1.37.0) ##### 🚀 Features - **(hook)** add env support to hooks by [@jdx](https://github.com/jdx) in [#709](jdx/hk#709) - parse Go-style diffs by [@jdx](https://github.com/jdx) in [#704](jdx/hk#704) ##### 🐛 Bug Fixes - **(builtins)** strip extra trailing newlines in end-of-file-fixer by [@jdx](https://github.com/jdx) in [#708](jdx/hk#708) - **(docs)** correctly document what --all is about by [@nkakouros](https://github.com/nkakouros) in [#715](jdx/hk#715) - **(git)** exclude untracked files from unstaged\_files set by [@nkakouros](https://github.com/nkakouros) in [#716](jdx/hk#716) - **(hkrc)** config format and load order by [@ivy](https://github.com/ivy) in [#710](jdx/hk#710) - **(release)** write release notes to file instead of capturing stdout by [@jdx](https://github.com/jdx) in [#688](jdx/hk#688) - **(release)** make release notes editorialization non-blocking by [@jdx](https://github.com/jdx) in [#690](jdx/hk#690) - **(step)** gate check\_diff forced check\_first on Fix mode only by [@nkakouros](https://github.com/nkakouros) in [#717](jdx/hk#717) ##### 📚 Documentation - **(shanty)** add audio player with sea shanty recording by [@jdx](https://github.com/jdx) in [67a25ad](jdx/hk@67a25ad) - document config file search paths by [@ivy](https://github.com/ivy) in [#701](jdx/hk#701) - require AI disclosure on GitHub comments by [@jdx](https://github.com/jdx) in [#703](jdx/hk#703) ##### 🔍 Other Changes - replace gen-release-notes script with communique by [@jdx](https://github.com/jdx) in [#700](jdx/hk#700) - add autofix.ci workflow by [@jdx](https://github.com/jdx) in [#705](jdx/hk#705) ##### 📦️ Dependency Updates - lock file maintenance by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#686](jdx/hk#686) - update taiki-e/upload-rust-binary-action digest to [`f391289`](jdx/hk@f391289) by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#692](jdx/hk#692) - update anthropics/claude-code-action digest to [`c22f7c3`](jdx/hk@c22f7c3) by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#691](jdx/hk#691) - update rust crate libc to v0.2.181 by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#694](jdx/hk#694) - update rust crate clap to v4.5.58 by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#693](jdx/hk#693) - lock file maintenance by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#695](jdx/hk#695) - update anthropics/claude-code-action digest to [`edd85d6`](jdx/hk@edd85d6) by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#698](jdx/hk#698) - update rust crate clap to v4.5.60 by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#699](jdx/hk#699) - lock file maintenance by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#702](jdx/hk#702) - lock file maintenance by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#711](jdx/hk#711) ##### New Contributors - [@ivy](https://github.com/ivy) made their first contribution in [#710](jdx/hk#710) - [@nkakouros](https://github.com/nkakouros) made their first contribution in [#715](jdx/hk#715) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

docs: document config file search paths

d95bd4a

List all supported config file paths and their precedence order, the directory walk-up behavior, and differences from mise's config resolution for users coming from that tool. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

gemini-code-assist Bot reviewed Feb 21, 2026

View reviewed changes

Comment thread docs/configuration.md Outdated

docs: clarify ambiguity in load order precedence table

09d4244

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

jdx merged commit 9090645 into jdx:main Feb 21, 2026
18 checks passed

jdx mentioned this pull request Feb 21, 2026

chore: release v1.38.0 #687

Merged

ivy deleted the docs/config-file-paths branch February 21, 2026 23:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: document config file search paths#701

docs: document config file search paths#701
jdx merged 2 commits intojdx:mainfrom
ivy:docs/config-file-paths

ivy commented Feb 21, 2026

Uh oh!

gemini-code-assist Bot commented Feb 21, 2026

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

Uh oh!

ivy commented Feb 21, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

ivy commented Feb 21, 2026

Uh oh!

gemini-code-assist Bot commented Feb 21, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

ivy commented Feb 21, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants