Mac Developer Library Developer


This manual page is part of Xcode Tools version 5.0

To obtain these tools:

If you are running a version of Xcode Tools other than 5.0, view the documentation locally:

  • In Xcode

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • To learn how the manual is organized or to learn about command syntax, read the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Developer Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.

instruments(1)            BSD General Commands Manual           instruments(1)


     instruments [-t template] [-D document] [-l timeLimit] [-i #] [-w device] [[-p pid] | [application [-e
     variable value] [argument ...]]]

     Runs an Instruments template from the command line.

     Options are :

     -t template
              The path to the template to run

     -s       Show list of known templates and exit

     -D document
              The path to save the trace document data to (This may already exist, in which case a new Run
              will be added)

     -l #     The limit of milliseconds to record until termination ( infinite is default )

     -i #     The index of the instrument to apply the following target data to ( default if missing )

     -p pid   The ID of the process to attach to

              The path to the application or command to launch

     -w hardware device
              The identifier of the hardware to target

     -e variable value
              An environment variable setting (You may specify more than one)

              Command line argument to be sent to the launched process (You may specify more than one)

     -v       Turn on verbose logging

SEE ALSO may be used to perform trace executions in a graphical environment and may also be used
     to open trace documents created by instruments.

     instruments -t mytemplate

Mac OS                         October 11, 2013                         Mac OS

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.