From d2b64a395c117c73191560629062b29127bbb940 Mon Sep 17 00:00:00 2001 From: Martin Kagamino Lehoux Date: Tue, 12 May 2026 18:11:27 +0200 Subject: docs: update kdev section with flags table and known limitation Co-Authored-By: Claude Sonnet 4.6 --- README.md | 30 +++++++++++++++++++++++++----- 1 file changed, 25 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1f3e223..def2674 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,32 @@ ## kdev -`go run github.com/martinlehoux/kagamigo/cmd/kdev --repo=` +`go run github.com/martinlehoux/kagamigo/cmd/kdev@latest --repo= --keywords=TODO` -- [ ] Ignore bin files or too large -- [ ] Ignore regex -- [ ] Parallel -- [ ] Log level +Scans a git repository for keyword occurrences and shows when each matching line was last modified (via `git blame`). + +### Flags + +| Flag | Default | Description | +|------|---------|-------------| +| `--repo` | `.` | Path to the repository | +| `--keywords` | _(required)_ | Comma-separated keywords to search for | +| `--max` | `25` | Maximum number of results to display | +| `--sort` | `date` | Sort order: `date` or `random` | +| `--after` | | Only show results after this date (ISO format) | +| `--before` | | Only show results before this date (ISO format or `7d`) | +| `--algo` | `git` | Blame algorithm: `git`, `go-git`, or `stat` | +| `--workers` | `NumCPU` | Number of parallel workers | +| `--maxFileSize` | `1048576` | Skip files larger than this size in bytes | +| `--ignore` | | Regex patterns to skip files by relative path | +| `--excludes` | `.git,.kdev.yaml` | Directory/file names to exclude | +| `--logLevel` | `info` | Log level: `debug`, `info`, `warn`, `error` | + +Settings can also be stored in `.kdev.yaml` at the repo root. + +### Known limitation + +`git blame` runs once per file with keyword matches (not per line). For repositories with many matching files, `--workers` controls parallelism. ## ki18n -- cgit v1.3