User Guide

Contents

Launch
Intel® Advisor
Command Line Interface

Steps to
run
Intel® Advisor
from command line and ramp up with its command line interface (CLI)
.

Prerequisites

Set up environment variables to enable the command line interface.

Run the
Intel® Advisor
CLI

The
Intel® Advisor
CLI is available from a command line on Windows* or Linux* OS systems.
To run the
advisor
command line interface, use the following syntax:
advisor <--action> [--action-options] [--global-options] -- <target> [target options]
where:
  • <--action>
    is an
    Intel® Advisor
    action to do, such as
    collect
    or
    report
    .
  • [--action-options]
    and
    [--global-options]
    are options to modify action behavior.
  • <target>
    is an application executable to analyze with optional
    [target-options]
    to apply to the target.
The
advisor
command line interface supports all
Intel® Advisor
perspective and is the recommended method to run the
Intel® Advisor
from command line.
You can also run the
Offload Modeling
perspective using Python* scripts as follows:
advisor-python <APM>/<offload-script>.py <project-dir> [--options] [-- <target> [target-options]]
where:
  • <APM>
    is the environment variable that points to the directory with the
    Intel® Advisor
    scripts. It is
    $APM
    for Linux* OS and
    %APM%
    for Windows* OS.
  • <offload-script>
    is a script to run:
    run_oa
    ,
    collect
    , or
    analyze
    .
  • <project-dir>
    is a path to a project directory.
  • [--options]
    is options to modify script behavior.
  • <target>
    is an application executable to analyze with optional
    [target-options]
    to apply to the target.
When you run the first
Intel® Advisor
analysis to a target application from the command line, it also creates new project for the target.
For details about the
Intel® Advisor
command line syntax and options, see the advisor Command Line Interface Reference. Review the typical workflows for the
Intel® Advisor
CLI in the dedicated topics for each perspective, see
Related Links
below.

Product and Performance Information

1

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