Installation Guide

  • 2021.4
  • 09/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:
Option
Supported mode
Default value (if option is not passed)
Description
-c
,
--cli
CLI
N/A
Run the installer in interactive text-based user interface (TUI) mode.
-s
,
--silent
Silent
N/A
Run the installer in non-interactive (silent) mode.
eula
Silent
decline
Required. Accept or decline End User License Agreement (EULA), supported values:
accept
or
decline
(default).
action
Silent/CLI
install
Specify one of the supported values below when the installer action is needed:
  • install
    (default) Install the product. Use the
    --components
    option to specify the list of components to be installed. If not specified, the default set of components is installed.
  • remove
    Uninstall the product.
  • modify
    Change the current set of components installed. List all the components you need using the
    --components
    option. Components that are already installed still must be in the list if remain relevant.
  • downloadonly
    Download an offline installation package without installing it. To customize the list of components to be included into a package, use the
    --components
    option.
  • repair
    Repair the currently installed product.
--config
Silent/CLI
N/A
Point to the configuration INI file with options. You can use this file as an alternative to passing options via the command line; mixed approach is also supported. Sample content of a configuration file:
s=eula=accept
.
Use this command to run the installer with the options passed via
config.txt
:
sh ./l_[Toolkit Name]Kit_[version].sh --config config.txt
--components
Silent
default
Specify components to perform an action on, supported values:
all
,
default
, custom components split by ‘:’. If you need the default components and some extra component(s), combine
default
with the name of the extra component(s) separated by ‘:’. For example:
--components default:<component_name>
.
list-products
N/A
N/A
Get the list of downloaded products, their IDs, versions and statuses (installed/not installed).
product-id
Silent/CLI
N/A
Specify an ID of a product to perform an action on. Use this option with
--list-components
or
--action {install|remove|modify|repair}
.
product-ver
Silent/CLI
N/A
Specify a product version to perform an action on. Use this option with
--list-components
or
--action {install|remove|modify|repair}
.
list-components
N/A
N/A
Get the list of available components of the current package or of a product specified with
--product-id
.
--package-path
Silent/CLI
N/A
Specify the directory of the package to install.
--install-dir
Silent
default installation directory
Supported in silent mode. Customize the installation directory.
--log-dir
Silent/CLI
default log location
Customize the directory to save the log file to.
--proxy
Silent/CLI
N/A
Specify proxy settings in the following format:
http://username:password@proxy-server.mycorp.com:3128
.
--download-cache
Silent
default download cache location
Point to the directory to store all downloaded and cached files.
--download-dir
Silent
default download directory
Customize the download directory, which is used in download-only mode.
--intel-sw-improvement-program-consent
Silent
decline
Accept or decline participation in Intel Software Improvement Program, supported values:
accept
or
decline
(default). To get the program description, use the
--show-intel-sw-improvement-program-consent
command.
--show-intel-sw-improvement-program-consent
N/A
N/A
Show the detailed description of the Intel Software Improvement Program.
--ignore-errors
Silent/CLI
N/A
Complete installation even if non-critical errors occur. Check the log file for the list of errors occured and ignored during installation.
-h
,
--help
N/A
N/A
Show the installer help.
-p
,
--property
Silent/CLI
N/A
Pass additional custom options. 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 will be used. For example, the string
-p=option=a -p option=b
takes
b
as value for
option
.
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 silent mode:
    • root:
      sudo sh ./l_[Toolkit Name]Kit_[version].sh -a --silent --eula accept
    • user:
      sh ./l_[Toolkit Name]Kit_[version].sh -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:
    • root:
      /opt/intel/oneapi
    • user:
    ~/intel/oneapi
If you are using Intel GPU, you need to install the latest GPU drivers separately.
Interactive Installation
  1. Use the following command to launch the installer:
    • root:
      sudo sh ./l_[Toolkit Name]Kit_[version].sh -a --cli
    • user:
      sh ./l_[Toolkit Name]Kit_[version].sh -a --cli
    For the full list of supported command line options, refer to the General Instructions section.
  1. Follow the installer instructions.
  2. Once the installation is complete, verify that your toolkit has been installed to the correct directory:
    • root:
      /opt/intel/oneapi
    • user:
      ~/intel/oneapi

Examples

  • Display the list of already installed products and products included in the downloaded package:
    • root:
      sudo sh ./l_[Toolkit Name]Kit_[version].sh -a --silent --list-products
    • user:
      sh ./l_[Toolkit Name]Kit_[version].sh -a --list-products
    Example of output:
    ID Version Language Installed Name ============================================================================================ intel.oneapi.lin.tbb.product 2021.1.1-129 false Intel® oneAPI Threading Building Blocks
  • Display the list of components in product of current package:
    • root:
      sudo sh ./l_[Toolkit Name]Kit_[version].sh -a --list-components
    • user:
      sh ./l_[Toolkit Name]Kit_[version].sh -a --list-components
  • Display the list of components of any installed product on the system:
    • root:
      sudo sh ./l_[Toolkit Name]Kit_[version].sh -a --list-components --product-id intel.oneapi.lin.tbb.product --product-ver 2021.1.1-129
    • user:
      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® oneAPI Threading Building Blocks
  • Install specific Intel oneAPI Toolkit products and components:
    • root:
      sudo sh ./l_[Toolkit Name]Kit_[version].sh --silent --eula accept --components intel.oneapi.lin.tbb.devel
    • user:
      sh ./l_[Toolkit Name]Kit_[version].sh -a --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.