Running Scripts in Batch Mode - 2023.1 English

Vitis Unified IDE and Common Command-Line Reference Manual (UG1553)

Document ID
UG1553
Release Date
2023-07-17
Version
2023.1 English

The new Vitis IDE provides a powerful command-line interface (CLI). It supports both batch mode and interactive mode. The CLI examples can be found at <Vitis_Installation_Dir>/cli/examples directory. The examples cover features for workspace management, application management, end-to-end workflow for data center and embedded use cases.

For example, create a vector addition System project using a script:

  1. Review the script at $XILINX_VITIS/cli/examples/dc_use_case_1.py.
  2. Launch the script using the following command:
    vitis -new --source $XILINX_VITIS/cli/examples/dc_use_case_1.py
Tip: Some scripts require specific environment variables to be set before running it. For example, edge use case requires kernel, rootfs and sysroot information from environment variables. You are encouraged to review comments in the example scripts before running them.

For more information about Vitis CLI, see Vitis Interactive Python Shell and Library Function References.