Launch Options - 2025.2 English - UG1702

The Vitis Unified IDE supports the following modes:

Workspace Mode

Opens the Vitis Unified IDE with the specified workspace.

vitis -w <workspace>

Analysis Mode

Launches the tool directly into the Vitis Analyzer (see Working with the Analysis View (Vitis Analyzer)). You can review the summary reports the tool generates during build, run, and debug.

vitis -a

Interactive Mode

Allows you to enter commands through the command-line interface, outside of the GUI.

vitis -i

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

Batch Mode

Executes the specified 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.

vitis -j

You can use vitis_server command line interface in this environment as described in Vitis Interactive Python Shell.

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

vitis -h

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

Options:
  -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.