| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 1 | # Sketch |
| 2 | |
| David Crawshaw | 64d3299 | 2025-04-21 09:14:36 -0700 | [diff] [blame] | 3 | Sketch is an agentic coding tool focused on the Go programming language. |
| Josh Bleecher Snyder | db8c5ab | 2025-04-21 15:09:16 -0700 | [diff] [blame] | 4 | Sketch runs in your terminal, has a web UI, understands your code, and helps you get work done. |
| David Crawshaw | 64d3299 | 2025-04-21 09:14:36 -0700 | [diff] [blame] | 5 | To keep your environment pristine, sketch starts a docker container and outputs |
| 6 | its work onto a branch in your host git repository. |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 7 | |
| David Crawshaw | 64d3299 | 2025-04-21 09:14:36 -0700 | [diff] [blame] | 8 | To get started: |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 9 | |
| 10 | ```sh |
| 11 | go install sketch.dev/cmd/sketch@latest |
| 12 | sketch |
| 13 | ``` |
| David Crawshaw | 64d3299 | 2025-04-21 09:14:36 -0700 | [diff] [blame] | 14 | |
| 15 | ## Requirements |
| 16 | |
| Josh Bleecher Snyder | 5cef9db | 2025-04-22 16:44:13 -0700 | [diff] [blame] | 17 | Currently sketch runs on macOS and linux. |
| 18 | It uses docker/colima for containers. |
| 19 | |
| 20 | macOS: `brew install colima` |
| 21 | linux: `apt install docker.io` (or equivalent for your distro) |
| David Crawshaw | 64d3299 | 2025-04-21 09:14:36 -0700 | [diff] [blame] | 22 | |
| 23 | The [sketch.dev](https://sketch.dev) service is used to provide access |
| 24 | to an LLM service and give you a way to access the web UI from anywhere. |
| 25 | |
| 26 | ## Feedback/discussion |
| 27 | |
| 28 | We have a discord server to discuss sketch. |
| 29 | |
| David Crawshaw | b1fe3c8 | 2025-04-24 11:38:46 -0700 | [diff] [blame] | 30 | Join if you want! https://discord.gg/YNUSuVm4 |
| David Crawshaw | 64d3299 | 2025-04-21 09:14:36 -0700 | [diff] [blame] | 31 | |
| Philip Zeyliger | d43e572 | 2025-04-23 19:21:26 -0700 | [diff] [blame] | 32 | ## Development |
| 33 | |
| Pokey Rule | bbca240 | 2025-04-24 09:37:58 +0100 | [diff] [blame] | 34 | See [CONTRIBUTING.md](CONTRIBUTING.md) |
| Philip Zeyliger | d43e572 | 2025-04-23 19:21:26 -0700 | [diff] [blame] | 35 | |
| David Crawshaw | 64d3299 | 2025-04-21 09:14:36 -0700 | [diff] [blame] | 36 | ## Open Source |
| 37 | |
| 38 | Sketch is open source. |
| 39 | It is right here in this repository! |
| 40 | Have a look around and mod away. |
| 41 | |
| 42 | If you want to run sketch entirely without the sketch.dev service, you can |
| Philip Zeyliger | d43e572 | 2025-04-23 19:21:26 -0700 | [diff] [blame] | 43 | set the flag -skaband-addr="" and then provide an `ANTHROPIC_API_KEY` |
| David Crawshaw | 64d3299 | 2025-04-21 09:14:36 -0700 | [diff] [blame] | 44 | environment variable. (More LLM services coming soon!) |