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: README.md
+78-7Lines changed: 78 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,14 +30,16 @@ Foundry Local brings the power of Azure AI Foundry to your local device **withou
30
30
```bash
31
31
winget install Microsoft.FoundryLocal
32
32
```
33
-
For any issues, refer to the [Installation section](https://github.com/microsoft/Foundry-Local#installing) below.
34
33
- **MacOS**: Open a terminal and run the following command:
35
34
```bash
36
35
brew tap microsoft/foundrylocal
37
36
brew install foundrylocal
38
37
```
39
38
Alternatively, you can download the installer from the [releases page](https://github.com/microsoft/Foundry-Local/releases) and follow the on-screen installation instructions.
40
39
40
+
> [!TIP]
41
+
> For any issues, refer to the [Installation section](#installing) below.
42
+
41
43
2. **Run your first model**: Open a terminal and run the following command to run a model:
42
44
43
45
```bash
@@ -165,15 +167,25 @@ async function streamCompletion() {
165
167
streamCompletion();
166
168
```
167
169
168
-
## Installing
170
+
## Manage
171
+
172
+
This section provides an overview of how to manage Foundry Local, including installation, upgrading, and removing the application.
173
+
174
+
### Installing
175
+
176
+
Foundry Local is available for Windows and macOS (Apple silicon only). You can install it using package managers or manually download the installer.
169
177
170
-
### Windows
178
+
#### Windows
171
179
172
-
Install Foundry Local using `winget install Microsoft.FoundryLocal`in a Windows console (PowerShell, cmd, etc.)
180
+
Install Foundry Local using the following commandin a Windows console (PowerShell, cmd, etc.):
173
181
174
-
You can also manually download and install the packages. On [the releases page](https://github.com/microsoft/Foundry-Local/releases)
175
-
selecta release and expand the Artifacts list. Copy the artifact full URI (like `https://github.com/microsoft/Foundry-Local/releases/download/v0.3.9267/FoundryLocal-x64-0.3.9267.43123.msix`)
176
-
to use in the below PowerShell steps. (Replace `x64` with `arm64` as needed.)
182
+
```bash
183
+
winget install Microsoft.FoundryLocal
184
+
```
185
+
186
+
Alternatively, you can also manually download and install the packages. On [the releases page](https://github.com/microsoft/Foundry-Local/releases)
187
+
selecta release and expand the Artifacts list. Copy the artifact full URI (for example: `https://github.com/microsoft/Foundry-Local/releases/download/v0.3.9267/FoundryLocal-x64-0.3.9267.43123.msix`)
188
+
to use in the below PowerShell steps. Replace `x64` with `arm64` as needed.
177
189
178
190
```powershell
179
191
# Download the package and its dependency
@@ -201,6 +213,65 @@ and include logs using one of these methods:
201
213
> Log files may contain information like user names, IP addresses, file paths, etc. Be sure to remove those
202
214
> before sharing here.
203
215
216
+
#### macOS
217
+
218
+
Install Foundry Local using the following commands in your terminal:
219
+
220
+
```bash
221
+
brew tap microsoft/foundrylocal
222
+
brew install foundrylocal
223
+
```
224
+
225
+
Alternatively, you can also manually download and install the packages by following these steps:
226
+
227
+
1. Download the latest release from [the releases page](https://github.com/microsoft/Foundry-Local/releases).
228
+
1. Unzip the downloaded file.
229
+
1. Open a terminal and navigate to the unzipped folder, run the following command to install Foundry Local:
230
+
231
+
```bash
232
+
./install-foundry.command
233
+
```
234
+
235
+
### Upgrading
236
+
237
+
To upgrade Foundry Local, run the following command in your terminal:
238
+
239
+
- **Windows**
240
+
```bash
241
+
winget upgrade --id Microsoft.FoundryLocal
242
+
```
243
+
244
+
- **macOS**:
245
+
If you installed Foundry Local using Homebrew, you can upgrade it with the following command:
246
+
```
247
+
brew upgrade foundrylocal
248
+
```
249
+
If you installed Foundry Local manually, you'll first need to uninstall the current version using:
250
+
```bash
251
+
uninstall-foundry
252
+
```
253
+
Then, follow the [installation instructions](#installing) to install the latest version.
254
+
255
+
### Uninstalling
256
+
To uninstall Foundry Local, run the following commandin your terminal:
257
+
258
+
- **Windows**: You can uninstall Foundry Local using `winget`in a Windows console (PowerShell, cmd, etc.):
259
+
```bash
260
+
winget uninstall Microsoft.FoundryLocal
261
+
```
262
+
Alternatively, you can also uninstall Foundry Local by navigating to **Settings > Apps > Apps & features**in Windows, finding "Foundry Local"in the list, and selecting the ellipsis (`...`) followed by **Uninstall**.
263
+
264
+
- **macOS**: If you installed Foundry Local using Homebrew, you can uninstall it with the following command:
265
+
```bash
266
+
brew rm foundrylocal
267
+
brew untap microsoft/foundrylocal
268
+
brew cleanup --scrub
269
+
```
270
+
If you installed Foundry Local manually, you can uninstall it by running the following commandin your terminal:
271
+
```bash
272
+
uninstall-foundry
273
+
```
274
+
204
275
## Features & Use Cases
205
276
206
277
- **On-device inference** - Process sensitive data locally for privacy, reduced latency, and no cloud costs
0 commit comments