Conversation
The screens are captured from the actual curses UI running the demo dataset in a pty, then rendered to SVG from the terminal buffer — text, colours and layout are what the program draws, not a mockup. Co-Authored-By: Claude <noreply@anthropic.com>
📝 WalkthroughWalkthroughThe README’s introductory, installation, and usage content was condensed. New sections document CSV requirements and configuration precedence, while the notes on matching behavior and MusicBrainz request limits were rewritten. ChangesREADME documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 96-100: Update the README configuration section to document that
config.json is stored under $XDG_CONFIG_HOME/chartarr when XDG_CONFIG_HOME is
set, while retaining the default path otherwise. State that credential prompting
is skipped for dry-run, match-only, and review-only workflows, and clarify that
CHARTARR_LIDARR_URL and CHARTARR_API_KEY take precedence over the shorter
environment variables.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: bcb6d753-0a19-4be4-a663-53dcc621532c
⛔ Files ignored due to path filters (3)
docs/match.svgis excluded by!**/*.svgdocs/push.svgis excluded by!**/*.svgdocs/review.svgis excluded by!**/*.svg
📒 Files selected for processing (1)
README.md
Comment on lines
+96
to
+100
| The first run asks for your Lidarr URL and API key (Settings > General > | ||
| Security) and stores them in `~/.config/chartarr/config.json`, readable | ||
| only by you. `LIDARR_URL` and `LIDARR_API_KEY` override the file, and the | ||
| `CHARTARR_`-prefixed versions work if the short names are already taken. | ||
| `chartarr --setup` reconfigures. |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win
Document the actual configuration path, trigger, and precedence.
config_path() uses $XDG_CONFIG_HOME/chartarr/config.json when XDG_CONFIG_HOME is set, and credential prompting is skipped for dry-run, match-only, and review-only workflows. Also, CHARTARR_LIDARR_URL/CHARTARR_API_KEY take precedence over the shorter environment variables; they are not merely fallbacks when those names are unavailable.
Suggested wording
-The first run asks for your Lidarr URL and API key (Settings > General >
-Security) and stores them in `~/.config/chartarr/config.json`, readable
-only by you. `LIDARR_URL` and `LIDARR_API_KEY` override the file, and the
-`CHARTARR_`-prefixed versions work if the short names are already taken.
+When a push needs credentials, chartarr asks for your Lidarr URL and API
+key (Settings > General > Security) and stores them in
+`$XDG_CONFIG_HOME/chartarr/config.json` (or `~/.config/chartarr/config.json`
+when unset), readable only by you. The `CHARTARR_`-prefixed variables take
+precedence over `LIDARR_URL` and `LIDARR_API_KEY`, and either set overrides
+the config file.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| The first run asks for your Lidarr URL and API key (Settings > General > | |
| Security) and stores them in `~/.config/chartarr/config.json`, readable | |
| only by you. `LIDARR_URL` and `LIDARR_API_KEY` override the file, and the | |
| `CHARTARR_`-prefixed versions work if the short names are already taken. | |
| `chartarr --setup` reconfigures. | |
| When a push needs credentials, chartarr asks for your Lidarr URL and API | |
| key (Settings > General > Security) and stores them in | |
| `$XDG_CONFIG_HOME/chartarr/config.json` (or `~/.config/chartarr/config.json` | |
| when unset), readable only by you. The `CHARTARR_`-prefixed variables take | |
| precedence over `LIDARR_URL` and `LIDARR_API_KEY`, and either set overrides | |
| the config file. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 96 - 100, Update the README configuration section to
document that config.json is stored under $XDG_CONFIG_HOME/chartarr when
XDG_CONFIG_HOME is set, while retaining the default path otherwise. State that
credential prompting is skipped for dry-run, match-only, and review-only
workflows, and clarify that CHARTARR_LIDARR_URL and CHARTARR_API_KEY take
precedence over the shorter environment variables.
alperien
added a commit
that referenced
this pull request
Jul 28, 2026
The screens are captured from the actual curses UI running the demo dataset in a pty, then rendered to SVG from the terminal buffer — text, colours and layout are what the program draws, not a mockup. SVGs keep the columns aligned in any viewer font by anchoring each run of text at its cell position, so the CJK row and the progress bar hold their shape. The text leads with what the tool is and what it looks like, tells the three stages alongside the screens instead of as a numbered lecture, and brings the facts current: --search downloading, the idle-albums note, the u key, monitoring versus downloading. One CI badge, the real demo closing line, and the options, CSV, config and notes sections tightened.
alperien
added a commit
that referenced
this pull request
Jul 31, 2026
The screens are captured from the actual curses UI running the demo dataset in a pty, then rendered to SVG from the terminal buffer — text, colours and layout are what the program draws, not a mockup. SVGs keep the columns aligned in any viewer font by anchoring each run of text at its cell position, so the CJK row and the progress bar hold their shape. The text leads with what the tool is and what it looks like, tells the three stages alongside the screens instead of as a numbered lecture, and brings the facts current: --search downloading, the idle-albums note, the u key, monitoring versus downloading. One CI badge, the real demo closing line, and the options, CSV, config and notes sections tightened.
alperien
added a commit
that referenced
this pull request
Jul 31, 2026
The screens are captured from the actual curses UI running the demo dataset in a pty, then rendered to SVG from the terminal buffer, text, colours and layout are what the program draws, not a mockup. SVGs keep the columns aligned in any viewer font by anchoring each run of text at its cell position, so the CJK row and the progress bar hold their shape. The text leads with what the tool is and what it looks like, tells the three stages alongside the screens instead of as a numbered lecture, and brings the facts current: --search downloading, the idle-albums note, the u key, monitoring versus downloading. One CI badge, the real demo closing line, and the options, CSV, config and notes sections tightened.
alperien
added a commit
that referenced
this pull request
Jul 31, 2026
The screens are captured from the actual curses UI running the demo dataset in a pty, then rendered to SVG from the terminal buffer, text, colours and layout are what the program draws, not a mockup. SVGs keep the columns aligned in any viewer font by anchoring each run of text at its cell position, so the CJK row and the progress bar hold their shape. The text leads with what the tool is and what it looks like, tells the three stages alongside the screens instead of as a numbered lecture, and brings the facts current: --search downloading, the idle-albums note, the u key, monitoring versus downloading. One CI badge, the real demo closing line, and the options, CSV, config and notes sections tightened.
alperien
added a commit
that referenced
this pull request
Jul 31, 2026
The screens are captured from the actual curses UI running the demo dataset in a pty, then rendered to SVG from the terminal buffer, text, colours and layout are what the program draws, not a mockup. SVGs keep the columns aligned in any viewer font by anchoring each run of text at its cell position, so the CJK row and the progress bar hold their shape. The text leads with what the tool is and what it looks like, tells the three stages alongside the screens instead of as a numbered lecture, and brings the facts current: --search downloading, the idle-albums note, the u key, monitoring versus downloading. One CI badge, the real demo closing line, and the options, CSV, config and notes sections tightened.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A proper README: screenshot up top, walkthrough with the match and push screens inline, and prose that reads like a person wrote it.
The screenshots are real output, not mockups
Each one is the actual curses UI running the demo dataset in a pty, frozen mid-draw. The captured byte stream (every escape sequence ncurses emitted) is replayed through a terminal emulator and the resulting screen buffer rendered to SVG — so the text, colours, dim attributes, progress bar and layout are exactly what the program draws.
SVG instead of PNG because it stays crisp on any display, weighs 4–6 KB per image, and diffs like text. Column alignment is enforced by construction: every run of text is anchored at its cell position and stretched to an exact width, so the columns can't drift no matter which monospace font the viewer's system has — including the CJK cells in the Fishmans row, which occupy exactly two columns each.
Verified in a real browser before committing: cherry accents, dim rows, the ★ and F♯A♯∞ glyphs, the aligned 男達の別れ title, the candidates panel, and the footer with the
u undokey from #4.What changed in the text
--searchactually downloading (--search now starts downloads for every album it pushes #6), the idle-albums note,uin the review keys, the monitored-vs-downloaded distinction39 albums, 36 artists · 1959–2017 ▂▄▄▂█▆▇ · mostly art rock)No code changes. CI runs the same suite as always.
Summary by CodeRabbit