Skip to content

Commit f875f0e

Browse files
Add apx to path
1 parent 851df35 commit f875f0e

1 file changed

Lines changed: 59 additions & 0 deletions

File tree

content/install-guides/performix.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,65 @@ Wait while the installer copies the files.
176176

177177
When the installation finishes, select **Close** to exit the installer.
178178

179+
## How do I use the Arm Performix CLI?
180+
181+
The CLI is useful when you prefer command-line workflows, rather than GUI or MCP-driven workflow.
182+
183+
The `apx` command-line tool is installed automatically, and you can find the binary at the following locations:
184+
185+
{{< tabpane-normal >}}
186+
{{< tab header="Linux" >}}
187+
On Linux, you can find it at:
188+
189+
```bash
190+
/opt/Arm\ Performix/assets/apx/apx
191+
```
192+
193+
For convenience, add it to your PATH or create an alias:
194+
195+
```bash
196+
export PATH="/opt/Arm Performix/assets/apx:$PATH"
197+
```
198+
{{< /tab >}}
199+
{{< tab header="Windows" >}}
200+
On Windows, the default install location depends on the installation scope you chose during setup:
201+
202+
- For a single-user install: `C:\Users\<username>\AppData\Local\Programs\Arm Performix`
203+
- For an all-users install: `C:\Program Files\Arm Performix`
204+
205+
Relative to the install location, the `apx` binary is at `\assets\apx\apx.exe`. For example, an all-users install places it at:
206+
207+
```text
208+
C:\Program Files\Arm Performix\assets\apx\apx.exe
209+
```
210+
211+
For convenience, add it to your PATH. In PowerShell, run:
212+
213+
```powershell
214+
$env:Path += ";C:\Program Files\Arm Performix\assets\apx"
215+
```
216+
{{< /tab >}}
217+
{{< tab header="macOS" >}}
218+
On macOS, you can find it at:
219+
220+
```bash
221+
/Applications/Arm\ Performix.app/Contents/assets/apx/apx
222+
```
223+
224+
For convenience, add it to your PATH or create an alias:
225+
226+
```bash
227+
export PATH="/Applications/Arm Performix.app/Contents/assets/apx:$PATH"
228+
```
229+
{{< /tab >}}
230+
{{< /tabpane-normal >}}
231+
232+
Use the CLI help for command-line usage, or for more detailed information see the [Arm Performix User Guide](https://developer.arm.com/documentation/110163/latest/):
233+
234+
```bash
235+
apx --help
236+
```
237+
179238
## What comes next after installing Arm Performix?
180239

181240
After completing these installation steps, you can simply launch the GUI or CLI to get started.

0 commit comments

Comments
 (0)