Skip to content

Commit 2a4bf5e

Browse files
committed
docs: 📝 add overlay usage instructions for pkgs.gen-commit
1 parent 8a84dc0 commit 2a4bf5e

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,34 @@ nix shell github:rodeyseijkens/gen-commit -c gen-commit [OPTIONS]
155155
}
156156
```
157157

158+
### Using Overlay (`pkgs.gen-commit`)
159+
160+
If you prefer using `pkgs.gen-commit`, add this flake's overlay:
161+
162+
```nix
163+
{
164+
inputs = {
165+
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
166+
gen-commit.url = "github:rodeyseijkens/gen-commit";
167+
};
168+
169+
outputs = { self, nixpkgs, gen-commit, ... }:
170+
{
171+
nixosConfigurations.yourHost = nixpkgs.lib.nixosSystem {
172+
system = "x86_64-linux";
173+
modules = [
174+
{
175+
nixpkgs.overlays = [gen-commit.overlays.default];
176+
environment.systemPackages = [
177+
pkgs.gen-commit
178+
];
179+
}
180+
];
181+
};
182+
};
183+
}
184+
```
185+
158186
## 🧠 How it works
159187

160188
The tool analyzes your git changes (staged, unstaged, or untracked files) and uses the `llm` command to generate an appropriate commit message following the Conventional Commits specification with gitmoji. You can optionally provide additional context using the `-n, --note` option to guide the LLM's message generation.

0 commit comments

Comments
 (0)