| commit | 3b44cc3120b595e82dcc2a6081b8a07fc24c739e | [log] [tgz] |
|---|---|---|
| author | Josh Bleecher Snyder <josharian@gmail.com> | Tue Jul 22 02:28:14 2025 +0000 |
| committer | Josh Bleecher Snyder <josharian@gmail.com> | Tue Jul 22 20:10:27 2025 -0700 |
| tree | 3d4f3c2911390428c0c89aa8dcd13dbfb035ce31 | |
| parent | f18aafd177a90b928b1c1babbe5e763f85eab56d [diff] |
loop: do slug generation outside the agent loop [This commit message written entirely by a human; it is all useful.] We can make a slug based on the first message. It's good enough. That keeps it--and the slug tool--out of the agent's context. It's also one fewer step for extremely short Sketch runs, which is the straw that broke this particular camel's back. This is a mild UI regression, in that there's a slight stall after the user types their first message, during which the slug is being generated. See (2) below. While we're here, add handling of compaction agent messages. This leaves two big TODOs outstanding: 1. Untangle the awful rats nest that is slug and branch management; we have callbacks back and forth and layers and locking and it's all confusing. One visible for that this ugliness takes is that every time the agent tries out a slug, the top bar in the webui updates, even if we then reject that slug as a duplicate. there are other forms of ugliness, just less visible. 2. Make slug generation concurrent with the rest of the agent, to avoid a short stall right after the user's first request (ick). When we make slug setting concurrent, we'll likely need to resuscitate the bashPermissionCheck, except it'll be "silently block and wait for background slug generation to complete", rather than "reject the tool call". Ditto for about_sketch, and any other tool call that expects the slug or branch name to be set. Generally, before undertaking this effort, we should fix (1) above, make convos generally concurrency safe (maybe COW?), and figure out to get race-enabled innie builds. Co-Authored-By: sketch <hello@sketch.dev> Change-ID: s8ac5f6a9faa611ebk
Sketch is an agentic coding tool. It draws the 🦉
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.
Grab the most recent nightly release.
Update by running sketch -update.
Clone this repo, and then run:
$ make $ ./sketch
Currently, Sketch runs on MacOS and Linux. It uses Docker for containers.
| Platform | Installation |
|---|---|
| MacOS | brew install colima (or OrbStack or Docker Desktop) |
| 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.
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.
When you start Sketch, it:
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.
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!
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.
You can interact directly with the container in three ways:
ssh sketch-ilik-eske-tcha-lott. We have automatically configured your SSH configuration to make these special hostnames work.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.
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.
Docker images, containers, and so forth tend to pile up. Ask Docker to prune unused images and containers:
docker system prune -a
See CONTRIBUTING.md for development guidelines.
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!)