Vitis Unified IDE Launch Options - 2025.1 English - UG1400

Launch Options

The Vitis Unified IDE supports the following modes:

GUI Mode

By default, Vitis Unified IDE launches in GUI mode with a graphical interface. Optionally, you can use the argument -w to specify the workspace to open.

vitis -w <workspace>

Analysis Mode

Analysis mode launches the tool directly into the Analysis View, letting you review the summary reports generated during the build, run, and debug processes.

vitis -a

Interactive Mode

Interactive mode lets you enter commands through the interactive Python shell, outside of the GUI, as described in Vitis Interactive Python Shell in the Vitis Reference Guide (UG1702).

vitis -i

Note: Type help() from the interactive command prompt to explore the available command modules.

Batch Mode

Batch mode executes the specified Python script and exits.

vitis -s <script>.py

Jupyter Notebook Mode

Launches Jupyter Notebook server with the Vitis environment and the front end UI in your default web browser.

Note: Jupyter notebook is supported in Linux OS.

vitis -j

You can use -h to print the supported options of vitis.

vitis -h

Syntax: vitis [-a | -w | -i | -s | -h | -v]

Options:
   Launches New Vitis IDE (default option).
  -a/--analyze [<summary file | folder | waveform file: *.[wdb|wcfg]>]
         Open the summary file in the Analysis view.
         Opening a folder opens the summary files found in the folder.
         Open the waveform file in a waveform view tab.
         If no file or folder is specified, opens the Analysis view.
  -w/--workspace <workspace_location>
         Launches Vitis IDE with the given workspace location.
  -i/--interactive
         Launches Vitis python interactive shell.
  -s/--source <python_script>
         Runs the given python script.
  -j/--jupyter
         Launches Vitis Jupyter Web UI.
  -h/--help
         Display help message.
  -v/--version
         Display Vitis version.