Skip to content

Add summary to vk pr output #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leynos merged 3 commits into from
Jul 20, 2025
Merged

Add summary to vk pr output #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
29431f3
Add comment summary for vk pr
leynos Jul 20, 2025
1d0e624
Refactor pr summary output
leynos Jul 20, 2025
7363e00
Improve summary tests and docs
leynos Jul 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 85 additions & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ yaml = ["toml", "ortho_config/yaml"]
[dev-dependencies]
tempfile = "3.20.0"
serial_test = "3.2.0"
rstest = "0.25.0"

[lints.clippy]
# make every pedantic lint emit a warning
Expand Down
31 changes: 19 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# View Komments (vk)

`vk` stands for **View Komments** because `vc` was already taken back in the 1970s and no one argues with a greybeard. This command line tool fetches unresolved GitHub code review comments for a pull request and displays them with colourful terminal markdown using [Termimad](https://crates.io/crates/termimad).
`vk` stands for **View Komments** because `vc` was already taken back in the
1970s, and no one argues with a greybeard. This command line tool fetches
unresolved GitHub code review comments for a pull request and displays them with
colourful terminal markdown using
[Termimad](https://crates.io/crates/termimad).

This tool is intended for use by AI coding agents such as Aider, OpenAI Codex or Claude Code (without implying association with any of these companies).
This tool is intended for use by AI coding agents such as Aider, OpenAI Codex or
Claude Code (without implying association with any of these companies).

## Usage

Expand All @@ -16,28 +21,29 @@ sets the default repository when passing only a pull request number.

The CLI provides two subcommands:

* `pr` - show unresolved pull request comments (existing behaviour)
* `issue` - read a GitHub issue (**to do**)
* `pr` — show unresolved pull request comments. A summary of files and comment
counts is printed first.
* `issue` — read a GitHub issue (**to do**)

If you pass just a pull request number, `vk` tries to work out which
repository you meant. It first examines `.git/FETCH_HEAD` for a GitHub remote
URL and, if found, extracts the `owner/repo` from it. As the Codex agent does not put the
If you pass just a pull request number, `vk` tries to work out which repository
you meant. It first examines `.git/FETCH_HEAD` for a GitHub remote URL and, if
found, extracts the `owner/repo` from it. As the Codex agent does not put the
upstream URL in `.git/config`, we must obtain this from `FETCH_HEAD` for now.
Failing that, it falls back to the configured repository (`--repo` or
`VK_REPO`). Set this value to `owner/repo` with or without a `.git` suffix. If
neither source is available, `vk` will refuse to run with only a number.

`vk` uses the GitHub GraphQL API. Set `GITHUB_TOKEN` to authenticate. If it's not
set you'll get a warning and anonymous requests may be rate limited.
`vk` uses the GitHub GraphQL API. Set `GITHUB_TOKEN` to authenticate. If it's
not set, you'll get a warning and anonymous requests may be rate limited.

The token only needs read access. Select the `public_repo` scope (or `repo` for
private repositories). See [docs/GITHUB_TOKEN.md](docs/GITHUB_TOKEN.md) for a
detailed guide to creating one.

## Example

```
$ vk pr https://github.com/leynos/mxd/pull/31
```bash
vk pr https://github.com/leynos/mxd/pull/31
```

## Troubleshooting
Expand All @@ -56,4 +62,5 @@ cargo install --path .

## License

This project is licensed under the ISC License. See [LICENSE](LICENSE) for details.
This project is licensed under the ISC Licence. See
[LICENSE](LICENSE) for details.
Loading