Documentation Index
Fetch the complete documentation index at: https://docs.taho.is/llms.txt
Use this file to discover all available pages before exploring further.
How It Works
Inky analyzes your commit diffs and generates improved commit messages using Claude CLI. It rewrites your message to follow conventional commit format, adds structuredSummary: and Test Plan: sections, and amends the commit automatically.
When you run Inky, it:
- Validates the working directory is clean and youโre not on the main branch
- Reads the current commit message and diff
- Checks that the diff is non-empty โ Inky wonโt process empty commits
- Sends both to Claude CLI with instructions for generating a better message
- Amends the commit with the improved message
- Tags the commit with
#inkyfor tracking
Usage
Run Inky through the Lift CLI, either isolated or as part of the full pipeline:Cleanup Mode
Cleanup mode replaces the commit message with a placeholder instead of generating a new one. This is useful when you want to reset a commit message before re-running the pipeline:"please wait: finding something to put here..." and the commit is still tagged with #inky.
Generated Message Format
Inky generates messages that follow these conventions:- Summary line under 72 characters
- Conventional commit prefix when appropriate (
feat:,fix:,refactor:, etc.) - Present tense (โAdd featureโ not โAdded featureโ)
- Summary and Test Plan sections included in the body
- Existing hashtags preserved (like
#inky,#doc)
If Inky determines your existing message is already good, it may keep it mostly as-is rather than rewriting it.
Flags
These flags are passed to Lift and apply when Inky runs:| Flag | Description |
|---|---|
-m | Run only Inky (skip other tools) |
-t NUM | Prepend a task number to the commit message (e.g., TAHO-123:) |
-c | Cleanup mode โ set a placeholder message instead of generating |
-q | Quiet mode โ suppress progress indicators |
TAHO and can be overridden via the inky.task_prefix config setting.