Learning Objectives #
After completing this section, you will be able to:
- Apply vxprj commands to your projects
- Import a vxprj-based project into Workbench
Overview of the vxprj Utility #
The vxprj utility is a command-line tool provided by VxWorks to create, configure, manage, and build projects.
It can be launched from both:
- Inside Workbench (integrated development environment)
- Outside Workbench, directly via the CLI
If you use vxprj outside Workbench, the project can later be imported into Workbench for further development.
This tutorial includes multiple screenshots showing the results of using common vxprj commands.
Getting Help for vxprj #
The vxprj utility includes built-in help to guide you through available commands and subcommands.
-
To view general help and command groups, type:
vxprj helpor simply:
vxprj
-
To get help for project-specific commands:
vxprj project help
-
To get help for a specific subcommand:
vxprj project <subcommand> help
Managing Projects with the vxprj Utility #
Now let’s walk through how to create and manage VxWorks projects using vxprj.
In the following examples, we’ll assume:
- A VSB named
myVSB - A VIP named
myVIP - A target board:
xlnx_zynqmp_3_0_0_1
1. Create a Project #
Use the vxprj project create command to generate a new project.
2. Configure VSB Options #
You can set options for your VxWorks Source Build (VSB) using:
vxprj vsb config
3. Configure VIP Components #
Add or modify VxWorks Image Project (VIP) components with:
vxprj vip component add
4. Build the Project #
Once everything is configured, build the project with:
vxprj project build
💡 Quick Reference:
- To list valid BSPs:
vxprj vsb listBsps - To list valid CPUs:
vxprj vsb listCpus
Importing vxprj Projects into Workbench #
If you created a project externally using vxprj, you’ll need to import it into Workbench for graphical editing, debugging, and simulation.
Steps include:
- Open Workbench.
- Use the Import Project option.
- Point to the directory containing your
vxprjproject. - Complete the wizard to finish the import.
Once imported, you can leverage all of Workbench’s tools—such as debugging, performance monitoring, and simulation—while continuing to manage builds with vxprj.
✅ With vxprj, you get the flexibility of command-line control combined with the visual power of Workbench. This hybrid approach is ideal for both automated builds and hands-on development.