https://github.com/sshh12/screen-complete
Screen complete is a proof of concept universal screenshot-based text completion tool.
https://github.com/sshh12/screen-complete
ai-productivity copilot cursor openai text-completion
Last synced: 11 months ago
JSON representation
Screen complete is a proof of concept universal screenshot-based text completion tool.
- Host: GitHub
- URL: https://github.com/sshh12/screen-complete
- Owner: sshh12
- License: mit
- Created: 2024-09-28T03:50:53.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-29T01:22:36.000Z (over 1 year ago)
- Last Synced: 2024-11-25T05:42:40.120Z (over 1 year ago)
- Topics: ai-productivity, copilot, cursor, openai, text-completion
- Language: Go
- Homepage:
- Size: 30.3 KB
- Stars: 14
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# screen-complete
> Screen complete is a proof of concept universal screenshot-based text completion tool. Inspired by tools like cursor and github copilot, it allows you to fill in arbitrary selected text on your screen using a hot key.
## Quick Start (Windows/OSX)
1. Download the latest version from the [releases page](https://github.com/sshh12/screen-complete/releases)
2. Create a config file `screen_complete.yml` with `openai_api_key: ...` (in the same directory)
3. Run `screen-complete` (OSX may require enabling screen recording permissions)
The UI/UX is extremely minimal, on a page you want to fill in text:
1. Place your cursor where you want to type text (or select text you want to replace)
1. Move your mouse (without clicking) the top left corner of the applicable window
2. Hold down `Ctrl+Q`
3. Move your cursor to the bottom right corner of the applicable window
4. Release `Ctrl+Q`
## Examples
| Description | Image |
|-------------|-------|
| Writing text in a google doc |  |
| Filling in the title of a GitHub issue |  |
| Drafting a reddit comment |  |
| Drafting a slack reply |  |
## Configuration
This tool currently supports OpenAI and Azure OpenAI. Only fields for Azure OR OpenAI are required.
### Via Environment Variables
```
AZURE_OPENAI_API_KEY=...
AZURE_OPENAI_ENDPOINT=...
AZURE_OPENAI_DEPLOYMENT=...
OPENAI_API_KEY=...
OPENAI_MODEL=... (optional)
```
### Via `screen_complete.yml`
```yaml
azure_openai_api_key: ...
azure_openai_endpoint: ...
azure_openai_deployment: ...
openai_api_key: ...
openai_model: ... (optional)
```
## Building
### Windows
1. Download the Mingw, then set system environment variables C:\mingw64\bin to the Path
2. `go build -o screen-complete.exe cmd\screen_complete\main.go`
### MacOS
1. `xcode-select --install`
2. `go build -o screen-complete cmd\screen_complete\main.go`
## Privacy
Your screen is only captured and sent to OpenAI when you release the hot key.