Command Line Options
Options for Package Extraction Script
-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 |
Unpack the installation package without launching 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. |
Arguments for Installer
Specify these arguments after the -a option.
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:
|
--instance |
Silent/CLI |
default |
Specify an ID of an installation instance. For example: sh ./l_[Toolkit Name]Kit_[version].sh -a --instance=<instance ID>. This option enables side-by-side installation of oneAPI products. Each instance is a separate installation entity with its own isolated environment. Product installed in one instance is not visible in another instance. If omitted, installation is performed in default instance. To get the list of available instances, use the --list-instances option. |
--list-instances |
Silent/CLI |
N/a |
Get the list of available installation instances. |
--config |
Silent/CLI |
N/A |
Point to the configuration INI file with options. Use this file as an alternative to passing options via the command line; mixed approach is also supported. Sample content of a configuration file: eula=accept action=install silent install-dir=/opt/intel/oneapi components=intel.oneapi.lin.dpcpp-cpp-compiler:intel.oneapi.lin.vtune Use this command to run the installer with the options passed via config.txt: sh ./l_[Toolkit Name]Kit_[version].sh -a -s --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). Use together with the --instance option to get the list of available products in a specific instance. For example: sh ./l_[Toolkit Name]Kit_[version].sh -a --list-products --instance=<instance ID>. |
--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. Use together with the --instance option to get the list of available components in a specific instance. For example: sh ./l_[Toolkit Name]Kit_[version].sh -a --list-components --instance=<instance 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. Usage example: -p=EclipseSource=custom -p=EclipsePath=<path-to-eclipse-executable>`` |
Command Line Options Usage 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