Skip to content

Commit 0f049ee

Browse files
authored
Update AI Shell docs for preview7 release (#339)
* Update AI Shell docs for preview7 release * fix typo * Add preview switch to install command * Fix typo
1 parent 9d40f1f commit 0f049ee

File tree

6 files changed

+113
-31
lines changed

6 files changed

+113
-31
lines changed

reference/docs-conceptual/AIShell/how-to/agent-openai.md

Lines changed: 74 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: OpenAI agent
33
description: Learn how to configure the OpenAI agent.
4-
ms.date: 08/25/2025
4+
ms.date: 09/09/2025
55
ms.topic: how-to
66
---
77
# OpenAI agent
@@ -27,7 +27,7 @@ You also need to give your GPT instance a `Name`, a `Description`, and a `System
2727
- `Description` - provides additional context about its purpose and capabilities
2828
- `SystemPrompt` - defines the behavior and personality of the GPT instance
2929

30-
These values are can be customized to fit your needs.
30+
You can customize these values to fit your needs.
3131

3232
## Configuration
3333

@@ -134,42 +134,98 @@ Azure OpenAI uses the following hierarchy of credentials for authentication:
134134
- `InteractiveBrowserCredential`
135135

136136
For more information about these credentials, see .NET documentation for
137-
[`DefaultAzureCredential`][07].
137+
[`DefaultAzureCredential`][09].
138138

139139
## Support for other OpenAI-compatible models
140140

141141
The OpenAI agent supports third-party AI services that implement the OpenAI API specifications. Some
142142
of these models are open source tools for running SLMs and LLMs locally. The OpenAI agent supports
143143
the following 3rd-party models:
144144

145-
- [**Ollama**][06]
146-
- [**LM Studio**][04]
147-
- [**Deepseek**][02]
148-
- [**LocalAI**][05]
149-
- [**Google Gemini**][01]
150-
- [**Grok**][03]
145+
- [**Ollama**][08]
146+
- [**LM Studio**][06]
147+
- [**Deepseek**][04]
148+
- [**LocalAI**][07]
149+
- [**Google Gemini**][03]
150+
- [**Grok**][05]
151+
- [**Foundry Local**][02]
151152

152-
For more information about endpoints and model names, see the 3rd-party documentation for the AI
153-
service you want to use.
153+
Foundry Local is an on-device AI inference solution from Microsoft, currently in public preview. AI
154+
Shell interfaces with it using the OpenAI agent. You must install and configure Foundry Local on
155+
your machine before you can use it with AI Shell. For more information, see
156+
[Get started with Foundry Local][01].
154157

155158
The OpenAI agent supports the following model names:
156159

157160
- `o1`
158161
- `o3`
159162
- `o4-mini`
163+
- `gpt-5`
160164
- `gpt-4.1`
161165
- `gpt-4o`
162166
- `gpt-4`
163167
- `gpt-4-32k`
164168
- `gpt-4-turbo`
165169
- `gpt-3.5-turbo`
166170
- `gpt-35-turbo` - Azure OpenAI name of the model
171+
- Any of the model IDs supported by Foundry Local
172+
173+
For more information about endpoints and model names, see the 3rd-party documentation for the AI
174+
service you want to use.
175+
176+
### Configure a Foundry Local endpoint
177+
178+
After you have Foundry Local installed, run the following commands to get the information you need
179+
to configure the OpenAI agent:
180+
181+
```powershell
182+
PS> foundry service start
183+
🟢 Service is already running on http://127.0.0.1:56952/.
184+
185+
PS> foundry model load phi-3.5-mini
186+
🕔 Loading model...
187+
🟢 Model phi-3.5-mini loaded successfully
188+
189+
PS> foundry service ps
190+
Models running in service:
191+
Alias Model ID
192+
🟢 phi-3.5-mini Phi-3.5-mini-instruct-generic-cpu
193+
```
194+
195+
This example starts the Foundry Local service, loads the `phi-3.5-mini` model, and lists the models
196+
in the running in the service.
197+
198+
Next, add a new GPT to your `openai.agent.json` file.
199+
200+
- The `foundry service start` shows the URI for the service. The `Endpoint` for the OpenAI agent is
201+
the URI plus `/v1`.
202+
- The `foundry service ps` command shows `ModelName` as the **Model ID**. Make sure you use the
203+
exact casing as shown in **Model ID**. Foundry Local is case-sensitive.
204+
- The API key is hardcoded to `OPENAI_API_KEY`.
205+
206+
```json
207+
{
208+
"GPTs": [
209+
{
210+
"Name": "foundry-local",
211+
"Description": "A GPT instance using Foundry Local.",
212+
"Endpoint": "http://127.0.0.1:56952/v1",
213+
"ModelName": "Phi-3.5-mini-instruct-generic-cpu",
214+
"Key": "OPENAI_API_KEY"
215+
}
216+
]
217+
218+
"Active": "foundry-local"
219+
}
220+
```
167221

168222
<!-- link references -->
169-
[01]: https://ai.google.dev/gemini-api/docs/openai
170-
[02]: https://api-docs.deepseek.com/
171-
[03]: https://docs.x.ai/docs/overview#migrating-from-another-llm-provider
172-
[04]: https://lmstudio.ai/docs/api/openai-api
173-
[05]: https://localai.io/
174-
[06]: https://ollama.com/blog/openai-compatibility
175-
[07]: xref:Azure.Identity.DefaultAzureCredential
223+
[01]: /azure/ai-foundry/foundry-local/get-started
224+
[02]: /azure/ai-foundry/foundry-local/what-is-foundry-local
225+
[03]: https://ai.google.dev/gemini-api/docs/openai
226+
[04]: https://api-docs.deepseek.com/
227+
[05]: https://docs.x.ai/docs/overview#migrating-from-another-llm-provider
228+
[06]: https://lmstudio.ai/docs/api/openai-api
229+
[07]: https://localai.io/
230+
[08]: https://ollama.com/blog/openai-compatibility
231+
[09]: xref:Azure.Identity.DefaultAzureCredential

reference/docs-conceptual/AIShell/how-to/aishell-reference.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: AI Shell command reference
33
description: Learn about the command-line options and commands available in AI Shell.
4-
ms.date: 08/25/2025
4+
ms.date: 09/09/2025
55
ms.topic: reference
66
---
77
# AI Shell command reference
@@ -412,6 +412,17 @@ Options:
412412

413413
- `-h`, `--help` - Show help and usage information
414414

415+
## AI Shell command history
416+
417+
AI Shell includes a modified version of PSReadLine. Like the PSReadLine module for PowerShell, AI
418+
Shell lets you use the arrow keys to navigate through your command history. AI Shell saves the
419+
history in a file named `AIShell_history.txt`, in the same location as the other PSReadLine history
420+
files:
421+
422+
- On Windows systems: `$Env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine`.
423+
- On non-Windows systems: `$Env:XDG_DATA_HOME/powershell/PSReadLine` or
424+
`$Env:HOME/.local/share/powershell/PSReadLine`.
425+
415426
<!-- link references -->
416427
[01]: media/aishell-reference/code-copy-command.gif
417428
[02]: media/aishell-reference/code-post-command.gif

reference/docs-conceptual/AIShell/install-aishell.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Install AI Shell
33
description: Learn how to install AI Shell on your system.
4-
ms.date: 03/03/2025
4+
ms.date: 09/09/2025
55
ms.topic: install-set-up-deploy
66
---
77
# Install AI Shell
@@ -90,7 +90,7 @@ To manually install AI Shell, follow the instructions for your platform:
9090
1. Install the AI Shell module from the PowerShell Gallery.
9191

9292
```powershell
93-
Install-PSResource -Name AIShell
93+
Install-PSResource -Name AIShell -Preview
9494
```
9595

9696
### [macOS](#tab/macos)
@@ -102,7 +102,7 @@ To manually install AI Shell, follow the instructions for your platform:
102102
1. Install the AI Shell module from the PowerShell Gallery.
103103

104104
```powershell
105-
Install-PSResource -Name AIShell
105+
Install-PSResource -Name AIShell -Preview
106106
```
107107

108108
### [Linux](#tab/linux)

reference/docs-conceptual/AIShell/overview.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: What is AI Shell?
33
description: Learn about AI Shell, an interactive shell that provides a chat interface with language models.
4-
ms.date: 05/21/2025
4+
ms.date: 09/09/2025
55
ms.topic: overview
66
---
77

@@ -17,7 +17,9 @@ The AI Shell project includes:
1717
- A framework for creating AI agents and other assistance providers
1818
- Integration with Windows Terminal and iTerm2 on macOS
1919
- A PowerShell module for integration with PowerShell. For more information, see the
20-
[AI Shell module][01].
20+
[AI Shell module][02].
21+
- Support for MCP servers and tools
22+
- Support for [Foundry Local][01] deployments
2123

2224
Each AI assistant is known as an agent. The initial release of AI Shell includes two agents:
2325

@@ -40,7 +42,7 @@ deeper integration with the shell. These features include:
4042

4143
AI Shell is currently a preview release. Some features of the tool are still being developed and are
4244
subject to change. For more information about the current version and a complete list of changes,
43-
see the [Release notes][03].
45+
see the [Release notes][05].
4446

4547
## Known issues
4648

@@ -66,14 +68,15 @@ Here are ways you can get involved:
6668

6769
- **File Issues:** If you encounter bugs, have suggestions for new features, or would like to report
6870
inconsistencies, open an issue on the [AI Shell GitHub repository][04].
69-
- **Join the discussions:** Join our community discussions in the [GitHub discussions][02] tab.
71+
- **Join the discussions:** Join our community discussions in the [GitHub discussions][03] tab.
7072
Share ideas, discuss potential improvements, connect with other users, and share any agents you
7173
create.
7274
- **Documentation:** If you notice any documentation gaps, you can suggest changes or submit PRs to
7375
improve our documentation.
7476

7577
<!-- link references -->
76-
[01]: /powershell/module/aishell/
77-
[02]: https://github.com/PowerShell/AIShell/discussions
78-
[03]: release-notes.md
78+
[01]: /azure/ai-foundry/foundry-local/what-is-foundry-local
79+
[02]: /powershell/module/aishell/
80+
[03]: https://github.com/PowerShell/AIShell/discussions
7981
[04]: https://github.com/PowerShell/AIShell/issues
82+
[05]: release-notes.md

reference/docs-conceptual/AIShell/release-notes.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,26 @@ title: AI Shell release notes
33
description: >
44
Find out what's new in the latest release of AI Shell, an interactive shell that provides a chat
55
interface with language models.
6-
ms.date: 08/25/2025
6+
ms.date: 09/09/2025
77
ms.topic: overview
88
---
99
# AI Shell Release Notes
1010

1111
This document outlines the changes and improvements made in each release of AI Shell. For a more
1212
complete list of changes, refer to the [Releases page][06] on GitHub.
1313

14+
## 1.0.0-preview.7 - 2025-09-05
15+
16+
This release includes the following changes:
17+
18+
- Move to Azure.Identity v1.14.2 and refactor the telemetry library (#404)
19+
- Use login shell on macOS to start `aish` in sidecar pane to inherit proper PATH (#403)
20+
- Properly escape tool description to avoid malformed Markup object (#408)
21+
- Add gpt-5 models to the supported model list (#409)
22+
- Update the history file name and exclude the environment and managed-identity credentials from
23+
Azure authentication flow (#412)
24+
- Keep the original casing of model name for custom endpoint to enable Foundry Local (#413)
25+
1426
## [1.0.0-preview.6][02] - 2025-07-24
1527

1628
<a id="1.0.0-preview.6"></a>

reference/docs-conceptual/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This documentation set contains cmdlet reference for the following modules.
2020
- [PSScriptAnalyzer][06]
2121

2222
<!-- link references -->
23-
[01]: /powershell/module/aishell
23+
[01]: ./AIShell/overview.md
2424
[02]: /powershell/module/microsoft.powershell.crescendo/
2525
[03]: /powershell/module/microsoft.powershell.secretmanagement/
2626
[04]: /powershell/module/microsoft.powershell.secretstore/

0 commit comments

Comments
 (0)