Skip to content

local review: correct the README and the dirty-tree warning #744

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
rgushchin merged 2 commits into from
Oct 27, 2026
Merged

local review: correct the README and the dirty-tree warning #744

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
501bec9
docs: local review reads commits from git, not a scratch clone
ftabba Oct 25, 2026
06c33b3
cli: correct the dirty-tree warning
ftabba Oct 25, 2026
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ sashiko review HEAD~3..HEAD
sashiko review --report-preexisting
```

Local review uses a temporary scratch clone for patch application, leaving your working tree and git metadata untouched.
Local review reads each commit in the range from git, without a scratch clone or patch application, and leaves your working tree untouched.

> [!IMPORTANT]
> **Data Privacy & API Costs:** Sashiko sends patch data and relevant surrounding files/history from your repository to your configured LLM provider. Ensure you are authorized to share this code with your chosen provider and monitor your token usage and billing, as multi-stage reviews can incur significant API costs. The Sashiko authors assume no liability for data transmission or API charges.
Expand Down
2 changes: 1 addition & 1 deletion src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2477,7 +2477,7 @@ async fn handle_review_command(
{
eprint_colored(display.color, Color::Yellow, "WARNING:")?;
eprintln!(
" Working directory is dirty. The AI reviewer might see uncommitted changes when analyzing files."
" Working directory is dirty. The review reads commits only, so uncommitted changes are not reviewed."
);
if !agent && std::io::stdin().is_terminal() {
eprint!("Do you want to proceed? [y/N]: ");
Expand Down
Loading