Skip to content

Commit 8af3482

Browse files
authored
Document Copilot's support for image inputs for CCA #18457 (#59357)
1 parent 1bfc481 commit 8af3482

File tree

2 files changed

+50
-0
lines changed

2 files changed

+50
-0
lines changed

content/copilot/how-tos/use-copilot-agents/coding-agent/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ topics:
99
children:
1010
- /create-a-pr
1111
- /make-changes-to-an-existing-pr
12+
- /provide-visual-inputs
1213
- /track-copilot-sessions
1314
- /review-copilot-prs
1415
- /create-custom-agents
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: Provide visual inputs to GitHub Copilot
3+
shortTitle: Provide visual inputs
4+
intro: 'You can attach images to issues or {% data variables.copilot.copilot_chat_short %} prompts to help {% data variables.product.prodname_copilot_short %} understand your task.'
5+
product: '{% data reusables.gated-features.copilot-coding-agent %}<br><a href="https://github.com/features/copilot/plans?ref_product=copilot&ref_type=engagement&ref_style=button" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline"><span>Sign up for {% data variables.product.prodname_copilot_short %}</span> {% octicon "link-external" height:16 %}</a>'
6+
versions:
7+
feature: copilot
8+
topics:
9+
- Copilot
10+
contentType: how-tos
11+
category:
12+
- Author and optimize with Copilot
13+
---
14+
15+
> [!NOTE]
16+
> For an overview of {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent).
17+
18+
## Introduction
19+
20+
{% data variables.copilot.copilot_coding_agent_short_cap_c %} can process images, such as a photo or screenshot of a sketch or design, as part of your task description. This is useful when you want to show {% data variables.product.prodname_copilot_short %} what you're trying to achieve visually, for example, when updating a UI or implementing a design.
21+
22+
You can provide images to {% data variables.product.prodname_copilot_short %} in two ways:
23+
24+
* **In an issue**: Add an image to the issue body, with a description of the task you want {% data variables.product.prodname_copilot_short %} to complete, then assign the issue to {% data variables.product.prodname_copilot_short %}.
25+
* **In {% data variables.copilot.copilot_chat_short %}**: Attach images to your prompt when you ask {% data variables.product.prodname_copilot_short %} to create a pull request.
26+
27+
## Attaching images to an issue
28+
29+
1. Navigate to the repository where you want to create the issue.
30+
1. Create a new issue or open an existing issue.
31+
1. In the issue body, drag and drop your image.
32+
1. Add a clear description of what you want {% data variables.product.prodname_copilot_short %} to do with the image. For example, "Let's update the login form to match this mockup".
33+
1. Assign the issue to {% data variables.product.prodname_copilot_short %}. For detailed instructions, see [Assign an issue to {% data variables.product.prodname_copilot_short %} on {% data variables.product.prodname_dotcom_the_website %}](/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr#assigning-an-issue-to-copilot-on-githubcom).
34+
35+
{% data variables.product.prodname_copilot_short %} will analyze the image along with your description when working on the task.
36+
37+
## Attaching images in {% data variables.copilot.copilot_chat_short %}
38+
39+
1. Open {% data variables.copilot.copilot_chat_short %}.
40+
1. Attach your image to the chat prompt, and use `/task` to describe what you want {% data variables.product.prodname_copilot_short %} to do. For example, "Update the notification badge to match this mockup".
41+
42+
For detailed instructions, see [Asking {% data variables.product.prodname_copilot_short %} to create a pull request from {% data variables.copilot.copilot_chat_short %} in {% data variables.product.prodname_dotcom_the_website %}](/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr#asking-copilot-to-create-a-pull-request-from-copilot-chat-in-githubcom).
43+
1. {% data variables.product.prodname_copilot_short %} will create a pull request using the image as context for the task.
44+
45+
## Further reading
46+
47+
* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr)
48+
* [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices)
49+
* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs)

0 commit comments

Comments
 (0)