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
description: Learn how to setup and use Terminal Chat in Windows Terminal Canary.
4
-
author: chrnguyen
5
-
ms.author: chrnguyen
6
-
ms.date: 11/15/2023
7
-
ms.topic: how-to
4
+
ms.date: 10/29/2024
5
+
ms.topic: overview
8
6
---
9
7
10
-
# Terminal Chat
11
-
Terminal Chat is a feature in [Windows Terminal Canary](https://github.com/microsoft/terminal#installing-windows-terminal-canary) that allows the user to chat with an AI service to get intelligent suggestions (such as looking up a command or explaining an error message) while staying in the context of their terminal.
8
+
# Terminal Chat (Experimental)
12
9
13
-
This feature does not ship with its own large-language model. For now, this feature is only available in Windows Terminal Canary and only supports [Azure OpenAI Service](https://azure.microsoft.com/products/ai-services/openai-service).
10
+
Terminal Chat is a new experimental feature that enables you to integrate [Windows Terminal Canary](https://github.com/microsoft/terminal#installing-windows-terminal-canary) with your preferred AI service.
14
11
15
-
Windows Terminal Canary only communicates with an AI service when the user sends a message in Terminal Chat. The chat history and name of the user’s active shell is also appended to the message that is sent to the AI service. The chat history is not saved by Windows Terminal Canary after their terminal session is over.
12
+
Once Terminal Chat is connected to your AI service provider (GitHub Copilot, Azure OpenAI, or OpenAI), you can ask questions specific to the shell you are using (PowerShell, CMD, WSL Ubuntu, Azure Cloud Shell, etc) while staying in the context of your terminal.
16
13
17
-
> [!NOTE]
18
-
> This feature is only available in [Windows Terminal Canary](https://github.com/microsoft/terminal#installing-windows-terminal-canary).
14
+
Terminal Chat can:
15
+
16
+
- Provide command syntax and descriptions
17
+
- Explain command line error messages
18
+
- Send code suggestions to command-line text editors
19
+
20
+
Terminal Chat does not ship with its own large-language model. For now, this experimental feature is only available in [Windows Terminal Canary](https://github.com/microsoft/terminal#installing-windows-terminal-canary) and only supports [GitHub Copilot](https://go.microsoft.com/fwlink/?linkid=2294410), [Azure OpenAI Service](https://azure.microsoft.com/products/ai-services/openai-service), and [OpenAI](https://openai.com/).
21
+
22
+
Terminal Chat only communicates with your selected AI service when you enter a message in the chat. The chat history and name of the user’s active shell is also appended to the message that is sent to the AI service. The chat history is not saved by Windows Terminal after the terminal session is over.
23
+
24
+
25
+
26
+
## Prerequisites
27
+
28
+
- This experimental feature is only available in [Windows Terminal Canary](https://github.com/microsoft/terminal#installing-windows-terminal-canary).
29
+
30
+
- An AI service provider subscription is required. GitHub Copilot, Azure OpenAI, and OpenAI are currently supported.
31
+
32
+
## Set up a Service Provider in Terminal Chat
33
+
To use Terminal Chat, you will need to connect GitHub Copilot or add an Azure OpenAI or OpenAI endpoint to your Terminal Chat settings.
34
+
35
+
1. Open Windows Terminal and select **Settings** from the drop-down menu on the far-right of the top menu bar.
19
36
20
-
37
+
2. Select the **Terminal Chat (Experimental)** tab to display the service provider configuration settings.
21
38
22
-
## Setting up Terminal Chat
23
-
To use Terminal Chat, you will need to add a service endpoint and key to the Terminal Chat settings of Windows Terminal Canary.
24
-
25
-
For now, Terminal Chat only supports Azure OpenAI Service. To get an Azure OpenAI Service endpoint and key, you will need to create and deploy an Azure OpenAI Service resource.
39
+
3. Select a **Service Provider**. A subscription to one of the following AI service providers is required to use Terminal Chat. You will need to set up and authenticate the AI service in the service provider settings. See below for the steps to activate your preferred AI service provider.
### Creating and Deploying an Azure OpenAI Service resource
43
+
**[GitHub Copilot](https://go.microsoft.com/fwlink/?linkid=2293915)**: Under Service Providers, select **GitHub Copilot**and **Authenticate via GitHub** to sign in to GitHub. Check **Set as active provider** to set GitHub Copilot as your active Service Provider.
30
44
31
-
To create and deploy an Azure OpenAI Service resource, please follow the official Azure OpenAI documentation on [creating and deploying an Azure OpenAI Service resource](/azure/ai-services/openai/how-to/create-resource).
45
+
To connect GitHub Copilot with Terminal Chat, you must have an active subscription for GitHub Copilot in your personal account, or you need to be assigned a seat by your organization. You can sign up for a [GitHub Copilot free trial](https://go.microsoft.com/fwlink/?linkid=2293915) in your personal account to evaluate GitHub Copilot.
32
46
33
-
In that documentation, you will learn how to:
47
+
34
48
35
-
1.[Create a resource](/azure/ai-services/openai/how-to/create-resource#create-a-resource)
49
+
> [!NOTE]
50
+
> If you have access to GitHub Copilot via your organization, you won't be able to use GitHub Copilot if your organization owner has disabled GitHub Copilot in the CLI. See "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization)."
51
+
52
+
For more information on how to use GitHub Copilot responsibly with Windows Terminal, see ["Responsible use of GitHub Copilot in Windows Terminal"](https://docs.github.com/en/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-copilot-in-windows-terminal).
53
+
54
+
**[Azure OpenAI](/azure/ai-services/openai/overview)**: Under Service Providers, select **Azure OpenAI**, enter an endpoint URL and key, select **Store** and **Save**.
55
+
56
+
57
+
58
+
To get an Azure OpenAI Service endpoint and key, you will need to create and deploy an Azure OpenAI Service resource.
36
59
37
-
2.[Deploy a model](/azure/ai-services/openai/how-to/create-resource#deploy-a-model)
60
+
-[Create and deploy an Azure OpenAI Service resource](/azure/ai-services/openai/how-to/create-resource)
38
61
39
-
You will need to use a `gpt-35-turbo` model with your deployment.
62
+
You will need to use a `gpt-35-turbo` model and ensure that the [jailbreak content filter](/azure/ai-services/openai/how-to/content-filters) is enabled for your deployment.
40
63
41
-
After creating a resource and deploying a model, you can find your Azure OpenAI Service endpoint and key by navigating to the **Chat** playground in Azure OpenAI Studio and selecting **View code** in the Chat session section.
64
+
After creating a resource and deploying a model, you can find your Endpoint and API key by navigating to the **Chat** playground in Azure OpenAI Studio and selecting **View code** in the Chat session section. The pop-up dialog will provide an endpoint URL and key that you can use in the Terminal Chat Service Provider settings.
**[OpenAI](https://openai.com/)**: Under Service Providers, select **OpenAI**, enter an endpoint URL and key, select **Store** and **Save**.
44
67
45
-
The **View code** pop-up dialog will show you a valid Azure OpenAI Service endpoint and key that you can use for Terminal Chat.
68
+
To get an OpenAI endpoint and key, you will need to refer to the OpenAI documentation.
46
69
47
-
### Saving and Storing your Terminal Chat settings
48
-
After entering your AI service endpoint and key in Terminal Chat settings, select **Store** and **Save** to store and save those values.
70
+
-[Developer quickstart: Create and export an API key](https://platform.openai.com/docs/quickstart/step-2-setup-your-api-key?desktop-os=windows)
49
71
50
-
This will allow you to use Terminal Chat with the AI service affiliated with your service endpoint.
72
+
OpenAI is provided by a third-party and not Microsoft. When you send a message in Terminal Chat, your Terminal Chat history per session and the name of your active shell profile is sent to the third-party AI service for use by OpenAI. Your use of OpenAI is governed by the relevant third-party terms, conditions, and privacy statement.
51
73
52
-
## Using Terminal Chat
74
+
## Examples for using Terminal Chat
53
75
76
+
The following examples demonstrate a few ways that you might consider using Terminal Chat.
77
+
78
+
79
+
80
+
-**Command suggestions**: Ask for a command that you would like to use. Terminal Chat also adds the name of the active shell to the prompt after it is sent, so if you are using PowerShell and ask "How do I make a new directory?", the response may be `md`, but if you are using an Ubuntu (Linux) command line with WSL, the response may be `mkdir`.
54
81
Clicking on the suggestion will copy it to the input line of the terminal. This will not run the suggestion for the user automatically.
55
82
56
-
83
+
-**Translate commands**: Terminal Chat can also be used to "translate" commands. For example, you can ask "What's `touch` in PowerShell?" or "How do I `touch` in PowerShell?" to get the suggestion of `New-Item`, a PowerShell command that is equivalent to the Linux / Unix-based `touch` command for creating a new file.
84
+
85
+
-**Explain an error**: If you've received an unfamiliar error response in your command line, copy and paste it into the Terminal Chat and ask for an explanation of the error code and how to fix it. For example, "How do I fix `Error: getaddrinfo ENOTFOUND`?"
57
86
58
-
## Tips & Tricks
87
+
-**Send code suggestions to command-line text editors**: If you're using a command-line text editor in WSL (like `nano` or `vi`), you can ask Terminal Chat to generate code and send the code suggestion to the editor by clicking the "Copy" button.
88
+
89
+
-**Find and describe PowerShell cmdlets**: A [cmdlet](/powershell/module/microsoft.powershell.management/) (pronounced command-let) is a lightweight script command used to perform a specific function in PowerShell. Terminal Chat can help you to find cmdlets that may be useful and can explain what task they accomplish. For example, "Find a cmdlet to show a list of active processes" would result in `Get-Process`. Or "Explain the `Get-ChildItem` cmdlet" would describe that the cmdlet is used to retrieve a list of items within a specified location.
59
90
60
91
### Terminal-specific context
61
92
@@ -69,12 +100,12 @@ This means that Terminal Chat can identify whether a user's active shell is Comm
69
100
70
101
### Assigning a keybinding to Terminal Chat
71
102
72
-
Terminal Chat can be set as a keybinding Action.
73
-
74
-
This can be done in **Actions** in the **Settings** UI. Add a new keybinding Action by selecting **+ Add new** and then picking **Toggle Terminal Chat** from the dropdown to add a new keybinding Action for the Terminal Chat feature.
103
+
Terminal Chat can be set as a keybinding in the **Actions** tab of Windows Terminal **Settings**. Add a new keybinding by selecting **+ Add new** and then selecting **Toggle Terminal Chat** from the dropdown to add a new keybinding Action for the Terminal Chat feature.
75
104
76
-
105
+
The new keybinding will also be reflected in the dropdown menu after these changes are saved.
77
106
78
-
The new keybinding will also be reflected in the dropdown menu after these changes are saved.
107
+
### Group Policy
79
108
80
-
109
+
Language Models and AI Services used by Terminal Chat can be disabled through the **Enabled Language Models/AI Providers** policy.
110
+
The Terminal Chat feature can also be disabled with the same policy.
111
+
To learn more, see the [Group Policies page](./group-policy.md).
0 commit comments