Skip to content

Commit 28d7e46

Browse files
Add tentative github copilot support (#59)
* Add tentative github copilot support * Update readme for github copilot support --------- Co-authored-by: Paul Li <[email protected]>
1 parent caf9905 commit 28d7e46

File tree

2 files changed

+107
-2
lines changed

2 files changed

+107
-2
lines changed

.github/copilot-instructions.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# Instructions
2+
3+
During your interaction with the user, if you find anything reusable in this project (e.g. version of a library, model name), especially about a fix to a mistake you made or a correction you received, you should take note in the `Lessons` section in the `.github/copilot-instructions.md` file so you will not make the same mistake again.
4+
5+
You should also use the `.github/copilot-instructions.md` file's "scratchpad" section as a Scratchpad to organize your thoughts. Especially when you receive a new task, you should first review the content of the Scratchpad, clear old different task if necessary, first explain the task, and plan the steps you need to take to complete the task. You can use todo markers to indicate the progress, e.g.
6+
[X] Task 1
7+
[ ] Task 2
8+
9+
Also update the progress of the task in the Scratchpad when you finish a subtask.
10+
Especially when you finished a milestone, it will help to improve your depth of task accomplishment to use the Scratchpad to reflect and plan.
11+
The goal is to help you maintain a big picture as well as the progress of the task. Always refer to the Scratchpad when you plan the next step.
12+
13+
# Tools
14+
15+
Note all the tools are in python. So in the case you need to do batch processing, you can always consult the python files and write your own script.
16+
17+
## Screenshot Verification
18+
19+
The screenshot verification workflow allows you to capture screenshots of web pages and verify their appearance using LLMs. The following tools are available:
20+
21+
1. Screenshot Capture:
22+
```bash
23+
venv/bin/python tools/screenshot_utils.py URL [--output OUTPUT] [--width WIDTH] [--height HEIGHT]
24+
```
25+
26+
2. LLM Verification with Images:
27+
```bash
28+
venv/bin/python tools/llm_api.py --prompt "Your verification question" --provider {openai|anthropic} --image path/to/screenshot.png
29+
```
30+
31+
Example workflow:
32+
```python
33+
from screenshot_utils import take_screenshot_sync
34+
from llm_api import query_llm
35+
36+
# Take a screenshot
37+
38+
screenshot_path = take_screenshot_sync('https://example.com', 'screenshot.png')
39+
40+
# Verify with LLM
41+
42+
response = query_llm(
43+
"What is the background color and title of this webpage?",
44+
provider="openai", # or "anthropic"
45+
image_path=screenshot_path
46+
)
47+
print(response)
48+
```
49+
50+
## LLM
51+
52+
You always have an LLM at your side to help you with the task. For simple tasks, you could invoke the LLM by running the following command:
53+
```
54+
venv/bin/python ./tools/llm_api.py --prompt "What is the capital of France?" --provider "anthropic"
55+
```
56+
57+
The LLM API supports multiple providers:
58+
- OpenAI (default, model: gpt-4o)
59+
- Azure OpenAI (model: configured via AZURE_OPENAI_MODEL_DEPLOYMENT in .env file, defaults to gpt-4o-ms)
60+
- DeepSeek (model: deepseek-chat)
61+
- Anthropic (model: claude-3-sonnet-20240229)
62+
- Gemini (model: gemini-pro)
63+
- Local LLM (model: Qwen/Qwen2.5-32B-Instruct-AWQ)
64+
65+
But usually it's a better idea to check the content of the file and use the APIs in the `tools/llm_api.py` file to invoke the LLM if needed.
66+
67+
## Web browser
68+
69+
You could use the `tools/web_scraper.py` file to scrape the web.
70+
```
71+
venv/bin/python ./tools/web_scraper.py --max-concurrent 3 URL1 URL2 URL3
72+
```
73+
This will output the content of the web pages.
74+
75+
## Search engine
76+
77+
You could use the `tools/search_engine.py` file to search the web.
78+
```
79+
venv/bin/python ./tools/search_engine.py "your search keywords"
80+
```
81+
This will output the search results in the following format:
82+
```
83+
URL: https://example.com
84+
Title: This is the title of the search result
85+
Snippet: This is a snippet of the search result
86+
```
87+
If needed, you can further use the `web_scraper.py` file to scrape the web page content.
88+
89+
# Lessons
90+
91+
## User Specified Lessons
92+
93+
- You have a python venv in ./venv. Use it.
94+
- Include info useful for debugging in the program output.
95+
- Read the file before you try to edit it.
96+
- Due to Cursor's limit, when you use `git` and `gh` and need to submit a multiline commit message, first write the message in a file, and then use `git commit -F <filename>` or similar command to commit. And then remove the file. Include "[Cursor] " in the commit message and PR title.
97+
98+
## Cursor learned
99+
100+
- For search results, ensure proper handling of different character encodings (UTF-8) for international queries
101+
- Add debug information to stderr while keeping the main output clean in stdout for better pipeline integration
102+
- When using seaborn styles in matplotlib, use 'seaborn-v0_8' instead of 'seaborn' as the style name due to recent seaborn version changes
103+
- Use 'gpt-4o' as the model name for OpenAI's GPT-4 with vision capabilities
104+
105+
# Scratchpad

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Transform your $20 Cursor into a Devin-like AI Assistant
22

3-
This repository gives you everything needed to supercharge your Cursor or Windsurf IDE with **advanced** agentic AI capabilities—similar to the $500/month Devin—but at a fraction of the cost. In under a minute, you'll gain:
3+
This repository gives you everything needed to supercharge your Cursor/Windsurf IDE or GitHub Copilot with **advanced** agentic AI capabilities—similar to the $500/month Devin—but at a fraction of the cost. In under a minute, you'll gain:
44

55
* Automated planning and self-evolution, so your AI "thinks before it acts" and learns from mistakes
66
* Extended tool usage, including web browsing, search engine queries, and LLM-driven text/image analysis
@@ -26,7 +26,7 @@ Devin impressed many by acting like an intern who writes its own plan, updates t
2626
```
2727

2828
**Option 2: Manual Setup**
29-
Copy the provided config files into your project folder. Cursor users only need the .cursorrules file.
29+
Copy the `tools` folder and the following config files into your project root folder: Windsurf users need both `.windsurfrules` and `scratchpad.md` files. Cursor users only need the `.cursorrules` file. Github Copilot users need the `.github/copilot-instructions.md` file.
3030

3131
2. Planner-Executor Multi-Agent (Experimental)
3232

0 commit comments

Comments
 (0)