You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DEVELOPMENT.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,6 +41,10 @@ To run unit tests, just run test from the `Copilot for Xcode` target.
41
41
42
42
For new tests, they should be added to the `TestPlan.xctestplan`.
43
43
44
+
## Chat Plugins
45
+
46
+
To create a chat plugin, please use the `TerminalChatPlugin` as an example. You should add your plugin to the target `ChatPlugin` and register it in `ChatService`.
For frequently asked questions, check [FAQ](https://github.com/intitni/CopilotForXcode/issues/65).
27
28
28
29
For development instruction, check [Development.md](DEVELOPMENT.md).
29
30
@@ -127,6 +128,17 @@ Whenever you stop typing for a few milliseconds, the app will automatically fetc
127
128
128
129
Chat commands are not available in comment mode.
129
130
131
+
#### Chat Plugins
132
+
133
+
The chat panel supports chat plugins that may not require an OpenAI API key. For example, if you need to use the `/run` plugin, you just type
134
+
```
135
+
/run echo hello
136
+
```
137
+
138
+
| Command | Description |
139
+
|:---:|---|
140
+
|`/run`| Runs the command under the project root. You can also use environment variable `PROJECT_ROOT` to get the project root and `FILE_PATH` to get the editing file path.|
141
+
130
142
## Key Bindings
131
143
132
144
It looks like there is no way to add default key bindings to commands, but you can set them up in `Xcode settings > Key Bindings`. You can filter the list by typing `copilot` in the search bar.
@@ -164,7 +176,6 @@ fi
164
176
- The first run of the extension will be slow. Be patient.
165
177
- The extension uses some dirty tricks to get the file and project/workspace paths. It may fail, it may be incorrect, especially when you have multiple Xcode windows running, and maybe even worse when they are in different displays. I am not sure about that though.
166
178
- The suggestions are presented as C-style comments in comment mode, they may break your code if you are editing a JSON file or something.
167
-
- When a real-time suggestion request is triggered, there is a chance that it may briefly block the editor. This can occur at most once for each file after each restart of the extension because the extension needs to initiate real-time suggestion by clicking an item from the menu bar. However, once a command has been executed and some information is cached, the extension will be able to trigger real-time suggestion using a different method.
0 commit comments