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: articles/ai-foundry/foundry-local/reference/reference-cli.md
+21-21Lines changed: 21 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ ms.reviewer: samkemp
10
10
author: jonburchel
11
11
reviewer: samuel100
12
12
ms.topic: concept-article
13
-
ms.date: 07/03/2025
13
+
ms.date: 10/01/2025
14
14
---
15
15
16
16
# Foundry Local CLI Reference
@@ -38,20 +38,20 @@ The CLI organizes commands into three main categories:
38
38
The following table summarizes the commands related to managing and running models:
39
39
40
40
> [!NOTE]
41
-
> You can specify the `model` argument by its **alias** or **model ID**. Using an alias will:
41
+
> You can specify the `model` argument by its **alias** or **model ID**. Using an alias:
42
42
>
43
-
> -Select the _best model_ for your available hardware. For example, if you have a Nvidia CUDA GPU available, Foundry Local selects the CUDA model. If you have a supported NPU available, Foundry Local selects the NPU model.
44
-
> -Allow you to use a shorter name without needing to remember the model ID.
43
+
> -Selects the _best model_ for your available hardware. For example, if you have an Nvidia CUDA GPU available, Foundry Local selects the CUDA model. If you have a supported NPU available, Foundry Local selects the NPU model.
44
+
> -Lets you use a shorter name without needing to remember the model ID.
45
45
>
46
-
> If you want to run a specific model, you can use the model ID. For example, to run the `qwen2.5-0.5b` on CPU - irrespective of your available hardware - use: `foundry model run qwen2.5-0.5b-instruct-generic-cpu`.
46
+
> If you want to run a specific model, use the model ID. For example, to run the `qwen2.5-0.5b` on CPU - irrespective of your available hardware - use: `foundry model run qwen2.5-0.5b-instruct-generic-cpu`.
47
47
>
48
-
> If you have an Intel NPU on Windows, ensure you have installed the [Intel NPU driver](https://www.intel.com/content/www/us/en/download/794734/intel-npu-driver-windows.html) for optimal NPU acceleration.
48
+
> If you have an Intel NPU on Windows, ensure you install the [Intel NPU driver](https://www.intel.com/content/www/us/en/download/794734/intel-npu-driver-windows.html) for optimal NPU acceleration.
|`foundry model --help`| Displays all available model-related commands and their usage. |
53
-
|`foundry model run <model>`| Runs a specified model, downloading it if not cached, and starts an interaction. |
54
-
|`foundry model list`| Lists all available models for local use. On first run, downloads execution providers (EPs) for your hardware. |
53
+
|`foundry model run <model>`| Runs a specified model, downloads it if it isn't cached, and starts an interaction. |
54
+
|`foundry model list`| Lists all available models for local use. On first run, it downloads execution providers (EPs) for your hardware. |
55
55
|`foundry model list --filter <key>=<value>`| Lists models filtered by the specified criteria (device, task, alias, provider). |
56
56
|`foundry model info <model>`| Displays detailed information about a specific model. |
57
57
|`foundry model info <model> --license`| Displays the license information for a specific model. |
@@ -68,7 +68,7 @@ foundry model list --filter <key>=<value>
68
68
```
69
69
70
70
> [!NOTE]
71
-
> When you run `foundry model list` for the first time after installation, Foundry Local automatically downloads the relevant execution providers (EPs) for your machine's hardware configuration. You'll see a progress bar indicating the download completion before the model list is displayed.
71
+
> When you run `foundry model list` for the first time after installation, Foundry Local automatically downloads the relevant execution providers (EPs) for your machine's hardware configuration. You see a progress bar indicating the download completion before the model list appears.
72
72
73
73
**Supported filter keys:**
74
74
@@ -102,8 +102,8 @@ Filters models by their intended use case/task.
102
102
103
103
**Common values:**
104
104
105
-
-`chat-completion` - Conversational AI models
106
-
-`text-generation` - Text generation models
105
+
-`chat-completion`: Conversational AI models
106
+
-`text-generation`: Text generation models
107
107
108
108
#### alias - Model Alias
109
109
@@ -114,7 +114,7 @@ Filters models by their alias identifier. Supports wildcard matching with `*` su
114
114
-`phi4-cpu`
115
115
-`qwen2.5-coder-0.5b-instruct-generic-cpu`
116
116
-`deepseek-r1-distill-qwen-1.5b-generic-cpu`
117
-
-`Phi-4-mini-instruct-generic-cpu`
117
+
-`phi-4-mini-instruct-generic-cpu`
118
118
119
119
### Special filter features
120
120
@@ -140,9 +140,9 @@ foundry model list --filter provider=CUDAExecutionProvider
140
140
141
141
> [!NOTE]
142
142
>
143
-
> - All comparisons are case-insensitive
144
-
> - Only one filter can be used per command
145
-
> - Unrecognized filter keys will result in an error
143
+
> - All comparisons are case-insensitive.
144
+
> - Only one filter can be used per command.
145
+
> - Unrecognized filter keys result in an error.
146
146
147
147
## Service commands
148
148
@@ -157,16 +157,16 @@ The following table summarizes the commands related to managing and running the
157
157
|`foundry service status`| Displays the current status of the Foundry Local service. |
158
158
|`foundry service ps`| Lists all models currently loaded in the Foundry Local service. |
159
159
|`foundry service diag`| Displays the logs of the Foundry Local service. |
160
-
|`foundry service set <options>`|Set configuration of the Foundry Local service. |
160
+
|`foundry service set <options>`|Sets the configuration of the Foundry Local service. |
161
161
162
162
## Cache commands
163
163
164
-
The following table summarizes the commands related to managing the local cache where models are stored:
164
+
The following table summarizes the commands for managing the local cache where models are stored:
0 commit comments