app - 2025.2 English - UG1400

Vitis Unified Software Platform Documentation: Embedded Software Development (UG1400)
Document ID
UG1400
Release Date
2025-11-20
Version
2025.2 English

Application project management.

Table 1. app- Application Project Management
XSCT Methods Arguments Corresponding Python API Arguments Comments
app create -name <application-name> Name of the application to be created.

-platform <platform-name> Name of the platform. Use "repo -platforms" to list available pre-defined platforms.

-domain Name of the domain. Use "platform report <platform-name>" to list the available system configurations in a platform.

-hw <hw-spec> HW specification file exported from AMD Vivado™ (XSA).

-sysproj <system-project> Name of the system project. Use "sysproj list" to know available system projects in the workspace.

-proc <processor> Application is created for this core.
  1. client.create_aie_component

    (For AIE applications)

  2. client.create_app_component

    (For host components)

 Required arguments
  1. name = <comp_name> AIE component name.
  2. platform = <platform> or part = <part> Platform/part for which component is to be created. User needs to specify only one amongst platform or part.
Optional arguments
  1. template = <template>Template for the component to be created.
 In XSCT, the Vitis tool mentions the system project while creating the component (application). In Python CLI, Vitis tool creates the component first, then adds it to the system project. This gives a flexibility to add created components to be part of various system projects.
app create (cont'd)

-template <application template> Name of the template application. Default is 'Hello World'. Use "repo -apps" to list available template applications

-os <os-name> OS type. Default type is standalone.

-lang <programming language> Programming language can be c or c++.

-arch <arch-type> Processor architecture, <arch-type> can be 32 or 64 bits. This option is used to build the project with 32/64 bit toolchain

   Required arguments
  1. name = <comp_name>Application component name.
  2. platform = <platform> Platform for which component is to be created. In case of baremetal platforms, user can specify the domain along with platform.
Optional Arguments
  1. template = <template> Template for the component to be created.
  2. domain = <domain> Specify the domain when there is more than one domain on the platform.
  
app remove app_name client.delete_component name = <comp_name> Component name.  
switch app_name client.get_component name = <comp_name> Component name. Get command returns the app object that can be used to run app commands.
app list -dict List all the applications for the workspace in Tcl dictionary format. Without this option, applications are listed in tabular format.

(This argument is not supported in Python CLI)

 client.list_components    
app build -name <app-name> Name of the application to be built.

-all Name of the application to be built.Option to Build all the application projects.

(No support in Python CLI for -all)

 component.build   To build a component, component object is required. For example,

component1 = client.get_component('aie_component1')

component1.build()
app clean -name <app-name> component.clean omponent.clean  
app report app_name component.report