Skip to content

Commit d0bed0f

Browse files
committed
docs: extend README with info on hk cache
1 parent 0816cbe commit d0bed0f

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,25 @@ You can run fixes manually using:
3232
hk fix --all
3333
```
3434

35+
### Troubleshooting
36+
37+
It can be that `hk` uses an outdated configuration because of its internal caching mechanism.
38+
In this case you can clear the cache using:
39+
40+
```sh
41+
hk cache clear
42+
```
43+
44+
This may not help in all cases, especially when using remote configurations.
45+
You can try to run `pkl` directly to see if the configuration is as expected:
46+
47+
```sh
48+
pkl eval hk.pkl
49+
```
50+
51+
If the configuration is not as expected it may be that the remote file is cached by `pkl`.
52+
It is unclear though how to clear the `pkl` cache in this case, solution is usually to change the URL (e.g. by using a different tag or commit hash).
53+
3554
## Setting up hk in a new repository
3655

3756
As a prerequisite for all setups with hk we set up a mise configuration.

0 commit comments

Comments
 (0)