Get Started

  • 2022.2
  • 04/11/2022
  • Public Content

Build and Run a Sample Project Using the Command Line

Intel® oneAPI Base Toolkit
and
Intel® oneAPI HPC Toolkit
If you have not already configured your development environment, go to Configure Your System then return to this page. If you have already completed the steps to configure your system, continue with the steps below.
Command line development can be done with a terminal window or done through Visual Studio Code*. Some tasks can be automated using extensions. To learn more, see Using Visual Studio Code with Intel® oneAPI Toolkits.
To compile and run a sample:
  1. Locate a sample project using the oneAPI CLI Samples Browser.
  2. Build and run a sample project using Make*.

Download Samples using the oneAPI CLI Samples Browser

Use the oneAPI CLI Samples Browser to browse the collection of online oneAPI samples. As you browse the oneAPI samples, you can copy them to your local disk as buildable sample projects. Most oneAPI sample projects are built using Make or CMake, so the build instructions are included as part of the sample in a README file. The oneAPI CLI utility is a single-file, stand-alone executable that has no dependencies on dynamic runtime libraries.
An internet connection is required to download the samples for oneAPI toolkits. For information on how to use this toolkit offline, see Developing with Offline Systems in the Troubleshooting section.
To watch a video presentation of how to create a project with the command line, see Exploring Intel® oneAPI Samples from the Command Line.
  1. Open a terminal window.
  2. If you did not complete the steps in Option 2: One time set up for setvars.sh in the Configure Your System section, set system variables by sourcing setvars:
    For system wide installations (requires root or sudo privileges):
    . opt/intel/oneapi/setvars.sh
    For private installations:
    . ~/intel/oneapi/setvars.sh
    The command above assumes you installed to the default folder. If you customized the installation folder,
    setvars.sh
    is in your custom folder.
    The
    setvars.sh
    script can be managed using a configuration file, which is especially helpful if you need to initialize specific versions of libraries or the compiler, rather than defaulting to the "latest" version. For more details, see Using a Configuration File to Manage Setvars.sh. If you need to setup the environment in a non-POSIX shell, see oneAPI Development Environment Setup for more configuration options.
  3. In the same terminal window, run the application (it should be in your PATH):
    oneapi-cli
    The oneAPI CLI menu appears:
  4. Use the up and down arrow keys to select
    Create a project
    , then press
    Enter
  5. Select the language for your sample. For your first project, select
    cpp
    , then press
    Enter
    . The toolkit samples list appears.
  6. Select the
    Intrinsics C++
    sample. Intrinsics C++ is a simple test application that will help verify that the tools are setup correctly:
  7. After you select a sample, press
    Enter
    .
  8. Enter an absolute or a relative directory path to create your project. Provide a directory and project name. The Project Name is the name of the sample you chose in the previous step.
  9. Press
    Tab
    to select Create, then press
    Enter
    :

Build and Run a Project Using Make

  1. Open a command prompt.
  2. Navigate to where the Makefile is located.
  3. Build the program using Make.
    cd Intrinsics make all
  4. Run the program.
    make run
  5. Clean the program.
    make clean
See Explore SYCL* Through Samples to learn more.

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.