Skip to content

Commit 2de1d5c

Browse files
committed
Refreshes reference-cli.md
1 parent 90ba999 commit 2de1d5c

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

articles/ai-foundry/foundry-local/reference/reference-cli.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.reviewer: samkemp
1010
author: jonburchel
1111
reviewer: samuel100
1212
ms.topic: concept-article
13-
ms.date: 07/03/2025
13+
ms.date: 10/01/2025
1414
---
1515

1616
# Foundry Local CLI Reference
@@ -38,20 +38,20 @@ The CLI organizes commands into three main categories:
3838
The following table summarizes the commands related to managing and running models:
3939

4040
> [!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:
4242
>
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.
4545
>
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`.
4747
>
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.
4949
5050
| **Command** | **Description** |
5151
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
5252
| `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. |
5555
| `foundry model list --filter <key>=<value>` | Lists models filtered by the specified criteria (device, task, alias, provider). |
5656
| `foundry model info <model>` | Displays detailed information about a specific model. |
5757
| `foundry model info <model> --license` | Displays the license information for a specific model. |
@@ -68,7 +68,7 @@ foundry model list --filter <key>=<value>
6868
```
6969

7070
> [!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.
7272
7373
**Supported filter keys:**
7474

@@ -102,8 +102,8 @@ Filters models by their intended use case/task.
102102

103103
**Common values:**
104104

105-
- `chat-completion` - Conversational AI models
106-
- `text-generation` - Text generation models
105+
- `chat-completion`: Conversational AI models
106+
- `text-generation`: Text generation models
107107

108108
#### alias - Model Alias
109109

@@ -114,7 +114,7 @@ Filters models by their alias identifier. Supports wildcard matching with `*` su
114114
- `phi4-cpu`
115115
- `qwen2.5-coder-0.5b-instruct-generic-cpu`
116116
- `deepseek-r1-distill-qwen-1.5b-generic-cpu`
117-
- `Phi-4-mini-instruct-generic-cpu`
117+
- `phi-4-mini-instruct-generic-cpu`
118118

119119
### Special filter features
120120

@@ -140,9 +140,9 @@ foundry model list --filter provider=CUDAExecutionProvider
140140

141141
> [!NOTE]
142142
>
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.
146146
147147
## Service commands
148148

@@ -157,16 +157,16 @@ The following table summarizes the commands related to managing and running the
157157
| `foundry service status` | Displays the current status of the Foundry Local service. |
158158
| `foundry service ps` | Lists all models currently loaded in the Foundry Local service. |
159159
| `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. |
161161

162162
## Cache commands
163163

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:
165165

166166
| **Command** | **Description** |
167167
| ------------------------------ | -------------------------------------------------------------- |
168-
| `foundry cache --help` | Displays all available cache-related commands and their usage. |
169-
| `foundry cache location` | Displays the current cache directory. |
168+
| `foundry cache --help` | Shows all available cache-related commands and their usage. |
169+
| `foundry cache location` | Shows the current cache directory. |
170170
| `foundry cache list` | Lists all models stored in the local cache. |
171-
| `foundry cache cd <path>` | Changes the cache directory. |
172-
| `foundry cache remove <model>` | Deletes a model from the local cache. |
171+
| `foundry cache cd <path>` | Changes the cache directory to the specified path. |
172+
| `foundry cache remove <model>` | Removes a model from the local cache. |

0 commit comments

Comments
 (0)