| commit | 07e98cc3bbb33571af4f30b402c611ded849a323 | [log] [tgz] |
|---|---|---|
| author | Pokey Rule <755842+pokey@users.noreply.github.com> | Wed May 07 16:01:33 2025 +0100 |
| committer | Pokey Rule <755842+pokey@users.noreply.github.com> | Wed May 07 16:01:33 2025 +0100 |
| tree | cdd3eca6b8d0fb88fddf5cb410b99a31d97337e9 | |
| parent | 7ac5ed06fe591a4a5a904929e16a9d1982bfa781 [diff] |
docs: Update CONTRIBUTING and README for WebUI development server setup and usage
- .github/
- .vscode/
- bin/
- browser/
- claudetool/
- cmd/
- dockerimg/
- experiment/
- httprr/
- llm/
- loop/
- skabandclient/
- skribe/
- termui/
- webui/
- .clabot
- .gitignore
- CONTRIBUTING.md
- go.mod
- go.sum
- LICENSE
- README.md
Sketch
Sketch is an agentic coding tool focused on the Go programming language. 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.
To get started:
go install sketch.dev/cmd/sketch@latest sketch
Requirements
Currently sketch runs on macOS and linux. It uses docker for containers.
macOS: brew install colima (or an equivalent, like Docker Desktop or 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.
Feedback/discussion
We have a discord server to discuss sketch.
Join if you want! https://discord.gg/6w9qNRUDzS
Development
See CONTRIBUTING.md
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!)