commit	938d2dcde4aaea8119e1c09ffa453de48560dd57	[log] [tgz]
author	David Crawshaw <david@zentus.com>	Sat Jun 14 22:17:33 2025 +0000
committer	David Crawshaw <david@zentus.com>	Sat Jun 14 16:20:07 2025 -0700
tree	fe917e628d4ce1a671a15d1430668e92983289c4
parent	7351cd9b711db0e828d22d995fe56c7f9f6ddb07 [diff]

webui: add URL parameters for diff view from/to commit selection

Enable direct linking to specific diff ranges by adding URL parameters that
sync with the diff range picker controls, allowing users to bookmark and
share specific diff views.

Problem Analysis:
Users couldn't link directly to specific diff ranges in the sketch diff view.
The from/to commit selectors would reset to defaults on page load, making it
impossible to bookmark or share links to specific commit comparisons. This
created friction when collaborating or returning to specific diff views.

Implementation Changes:

1. URL Parameter Synchronization (sketch-diff-range-picker.ts):
   - Added updateUrlParams() to write from/to/commit parameters to URL
   - Integrated URL updates into dispatchRangeEvent() for automatic sync
   - Used history.replaceState() to update URL without page reload
   - Clear unused parameters when switching between range/single modes

2. URL Parameter Initialization:
   - Added initializeFromUrlParams() to read URL parameters on load
   - Parse 'from'/'to' parameters for range mode initialization
   - Parse 'commit' parameter for single commit mode initialization
   - Return flag indicating successful URL-based initialization

3. Load Flow Enhancement:
   - Modified loadCommits() to check URL parameters before setting defaults
   - Skip default commit selection when URL parameters are present
   - Always dispatch range event to ensure diff view updates correctly

4. Browser Navigation Support:
   - Added popstate event listener for browser back/forward navigation
   - Implemented handlePopState() to re-initialize from URL parameters
   - Force component re-render and event dispatch on navigation

5. Mode Switching Improvements:
   - Enhanced setRangeType() with better default handling
   - Auto-populate missing commits when switching between modes
   - Maintain proper URL state during mode transitions

Technical Details:
- URL parameters: 'from', 'to' for range mode; 'commit' for single mode
- Empty 'to' parameter represents uncommitted changes (working directory)
- Parameters removed from URL when switching to incompatible modes
- Browser history updated without triggering page reloads
- Component lifecycle properly manages event listeners

URL Format Examples:
- Range mode: ?view=diff2&from=abc123&to=def456
- Uncommitted: ?view=diff2&from=abc123 (no 'to' parameter)
- Single commit: ?view=diff2&commit=abc123

Benefits:
- Direct linking to specific diff ranges via URL
- Bookmarkable diff views for easy return navigation
- Shareable links for collaboration and code review
- Browser back/forward navigation works correctly
- URL reflects current diff state at all times
- Seamless integration with existing diff view functionality

Testing:
- Verified URL updates when changing from/to commit selectors
- Confirmed URL initialization on page load with parameters
- Tested browser back/forward navigation updates UI correctly
- Validated mode switching (range ↔ single) updates URL appropriately
- Ensured uncommitted changes mode removes 'to' parameter
- Confirmed sharing URLs loads correct diff view state

This enhancement enables direct linking and improved navigation for the
sketch diff view while maintaining all existing functionality and providing
seamless URL-based state management.

Co-Authored-By: sketch <hello@sketch.dev>
Change-ID: sbf02a6a8bb4db673k

webui/src/web-components/sketch-diff-range-picker.ts[diff]

1 file changed

tree: fe917e628d4ce1a671a15d1430668e92983289c4

README.md

Sketch

Sketch is an agentic coding tool. It draws the 🦉

🚀 Overview

Sketch runs in your terminal, has a web UI, understands your code, and helps you get work done. To keep your environment pristine, sketch starts a docker container and outputs its work onto a branch in your host git repository.

Sketch helps with most programming environments, but Sketch has extra goodies for Go.

📋 Quick Start

go install sketch.dev/cmd/sketch@latest
sketch

🔧 Requirements

Currently, Sketch runs on macOS and Linux. It uses Docker for containers.

Platform	Installation
macOS	`brew install colima` (or Docker Desktop/Orbstack)
Linux	`apt install docker.io` (or equivalent for your distro)
WSL2	Install Docker Desktop for Windows (docker entirely inside WSL2 is tricky)

The sketch.dev service is used to provide access to an LLM service and give you a way to access the web UI from anywhere.

🤝 Community & Feedback

Discord: Join our community at https://discord.gg/6w9qNRUDzS
GitHub Issues: Submit feedback at https://github.com/boldsoftware/sketch/issues

📖 User Guide

Getting Started

Start Sketch by running sketch in a Git repository. It will open your browser to the Sketch chat interface, but you can also use the CLI interface. Use -open=false if you want to use just the CLI interface.

Ask Sketch about your codebase or ask it to implement a feature. It may take a little while for Sketch to do its work, so hit the bell (🔔) icon to enable browser notifications. We won't spam you or anything; it will notify you when the Sketch agent's turn is done, and there's something to look at.

How Sketch Works

When you start Sketch, it:

Creates a Dockerfile
Builds it
Copies your repository into it
Starts a Docker container with the "inside" Sketch running

This design lets you run multiple sketches in parallel since they each have their own sandbox. It also lets Sketch work without worry: it can trash its own container, but it can't trash your machine.

Sketch's agentic loop uses tool calls (mostly shell commands, but also a handful of other important tools) to allow the LLM to interact with your codebase.

Getting Your Git Changes Out

Sketch is trained to make Git commits. When those happen, they are automatically pushed to the git repository where you started sketch with branch names sketch/*.

Finding Sketch branches:

git branch -a --sort=creatordate | grep sketch/ | tail

The UI keeps track of the latest branch it pushed and displays it prominently. You can use standard Git workflows to pull those branches into your workspace:

git cherry-pick $(git merge-base origin/main sketch/foo)

or merge the branch

git merge sketch/foo

or reset to the branch

git reset --hard sketch/foo

Ie use the same workflows you would if you were pulling in a friend's Pull Request.

Advanced: You can ask Sketch to git fetch sketch-host and rebase onto another commit. This will also fetch where you started Sketch, and we do a bit of "git fetch refspec configuration" to make origin/main work as a git reference.

Don't be afraid of asking Sketch to help you rebase, merge/squash commits, rewrite commit messages, and so forth; it's good at it!

Reviewing Diffs

The diff view shows you changes since Sketch started. Leaving comments on lines adds them to the chat box, and, when you hit Send (at the bottom of the page), Sketch goes to work addressing your comments.

Connecting to Sketch's Container

You can interact directly with the container in three ways:

Web UI Terminal: Use the "Terminal" tab in the UI
SSH: Look at the startup logs or click the information icon to see a command like ssh sketch-ilik-eske-tcha-lott. We have automatically configured your SSH configuration to make these special hostnames work.
Visual Studio Code: Look for a command line or magic link behind the information icon, or when Sketch starts up. This starts a new VSCode session "remoted into" the container. You can edit the code, use the terminal, review diffs, and so forth.

Using SSH (and/or VSCode) allows you to forward ports from the container to your machine. For example, if you want to start your development webserver, you can do something like this:

# Forward container port 8888 to local port 8000
ssh -L8000:localhost:8888 sketch-ilik-epor-tfor-ward go run ./cmd/server

This makes http://localhost:8000/ on your machine point to localhost:8888 inside the container.

Using Browser Tools

You can ask Sketch to browse a web page and take screenshots. There are tools both for taking screenshots and "reading images", the latter of which sends the image to the LLM. This functionality is handy if you're working on a web page and want to see what the in-progress change looks like.

❓ FAQ

"No space left on device"

Docker images, containers, and so forth tend to pile up. Ask Docker to prune unused images and containers:

docker system prune -a

🛠️ Development

See CONTRIBUTING.md for development guidelines.

📄 Open Source

Sketch is open source. It is right here in this repository! Have a look around and mod away.

If you want to run Sketch entirely without the sketch.dev service, you can set the flag -skaband-addr="" and then provide an ANTHROPIC_API_KEY environment variable. (More LLM services coming soon!)