Launch Options - 2023.1 English

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 -new -w <workspace>

Tip: If you do not specify a workspace when launching the tool, it will default to the last workspace opened.

Analysis Mode

Analysis mode launches the tool directly into the Working with the Analysis View (Vitis Analyzer) letting you review the summary reports generated during the build, run, and debug processes.

vitis -new -a

Interactive Mode

Interactive mode lets you enter commands through the command-line interface, outside of the GUI.

vitis -new -i

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

Batch Mode

Batch mode executes the specified script and exits.

vitis -new -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 -new -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 supported options of vitis -new.

vitis -new -h

Syntax: vitis -new [-g (default) | -a | -w | -i | -s | -h | -v]

Options:
  -a/--analyze [<summary file | folder>]
         Open the summary file in the Analysis view.
         Opening a folder opens the summary files found in the folder.
         If no file or folder is specified, opens the Analysis view.
  -g/--gui
         Launches Vitis IDE (default option).
  -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.