Installation Guide

  • 2021.2
  • 03/27/2021
  • Public Content

Install with Command Line

Command line installation supports the following installation modes:
  • Interactive mode prompts you to select or confirm certain options during the installation process
  • Non-interactive (silent) mode allows you to define the installation configuration only once and does not require any user input during installation
The general instructions below are common for both modes.

General Instructions

Launch the installation script using the following command:
sudo sh ./l_[Toolkit Name]Kit_[version].sh [options] -a [arguments]
where
[options]
contain parameters for the package extraction script, and
[arguments]
are options for the installer.
The package extraction script supports the following options:
-h
,
--help
Show help for the package extraction script.
-f
,
--extract-folder
Point to the folder where the package content will be saved.
-x
,
--extract-only
This option unpacks the installation package only. It does not launch the installer.
-r
,
--remove-extracted-files <yes|no>
Remove extracted files after installation. This action cleans up the temporary package file location.
-l
,
--log <log file>
Log all package extraction actions to the specified file.
-a <arguments>
Pass arguments to the installer.
The values after
-a
are passed as command line arguments to the installer. The following installer options are supported:
--action
Specify the install action, supported values:
install
,
remove
,
modify
,
downloadonly
,
repair
.
-c
,
--cli
Run the installer in interactive command line interface (CLI) mode.
--components
List components to perform action on, supported values:
all
,
default
, custom components split by ':'.
--config <config file>
Point to the configuration file with parameters.
--download-cache
Point to the directory to store all downloaded and cached files.
--download-dir
Set the download directory (used in download-only mode).
--eula
Required. Accept or decline End User License Agreement (EULA), supported values:
accept
or
decline
.
-h
,
--help
Show the installer help.
--install-dir
Set the installation directory.
--intel-sw-improvement-program-consent
Accept or decline participation in Intel Software Improvement Program, supported values:
accept
or
decline
.
--list-components
Get the list of available components for a particular product.
--list-products
Get the list of available products.
--log-dir
Specify the log directory.
--package-path
Specify the path to start the bootstrapper application from.
--product-id
Active product ID; used with
--list-components
,
--action {remove|modify|repair}
.
--product-lang
Active product language; used with
--list-components
,
--action {remove|modify|repair}
.
--product-ver
Active product version; used with
--list-components
,
--action {remove|modify|repair}
.
-p
,
--property
Provide additional custom parameters. For example, the string
-p=option1=value -p option2=value
gives two additional options. If a custom option is provided twice with different values, only the latest one is used. For example, the string
-p=option=a -p option=b
takes
b
as value for
option
.
--proxy
Specify proxy settings in the following format:
http://username:password@proxy-server.mycorp.com:3128
.
-s
,
--silent
Run the installation in silent mode.
For example, to show the installer help, use the following command:
sh ./l_[Toolkit Name]Kit_[version].sh -a -h

Non-interactive (Silent) Installation

  1. Use the following command to launch the installer in the silent mode:
    • root:
      sudo sh ./l_[Toolkit Name]Kit_[version].sh -s -a --silent --eula accept
    • user:
      sh ./l_[Toolkit Name]Kit_[version].sh -s -a --silent --eula accept
    For the full list of supported command line options, refer to the General Instructions section.
  2. Once the installation is complete, verify that the toolkit is installed in the default directory:
    /opt/intel/oneapi
    .
If you are using Intel GPU, you will need to install the GPU drivers separately.

Interactive Installation

  1. Use the following command to launch the installer:
    sudo sh ./l_[Toolkit Name]Kit_[version].sh -a --cli
    For the full list of supported command line options, refer to the General Instructions section.
  2. Follow the installer instructions.
  3. Once the installation is complete, verify that your toolkit is installed to the correct directory:
    /opt/intel/oneapi
If you are using Intel GPU, you will need to install the latest GPU drivers separately.

Other Commands and Examples

You can access additional installer capabilities using the commands below:
  • Display the list of already installed products and products included in the downloaded package:
    sh ./l_[Toolkit Name]Kit_[version].sh -a --silent --list-products
    Example of output:
    ID Version Language Installed Name ============================================================================================ intel.oneapi.lin.tbb.product 2021.1.1-129 false Intel(R) oneAPI Threading Building Blocks
  • Display the list of components in product of current package:
    sh ./l_[Toolkit Name]Kit_[version].sh -a --list-components
  • Display the list of components of any installed product on the system:
    sh ./l_[Toolkit Name]Kit_[version].sh -a --list-components --product-id intel.oneapi.lin.tbb.product --product-ver 2021.1.1-129
    Example of output:
    ID Version Language Installed Name ============================================================================================ intel.oneapi.lin.tbb.devel 2021.1.1-129 Intel(R) oneAPI Threading Building Blocks
  • Install specific Intel oneAPI Toolkit products and components:
    sudo sh ./l_[Toolkit Name]Kit_[version].sh --silent --eula accept --components intel.oneapi.lin.tbb.devel

Product and Performance Information

1

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