add InSpec CLI reference topic

docs/ctl_inspec.rst

@@ -0,0 +1,191 @@
+=====================================================
+InSpec CLI
+=====================================================
+
+Use the InSpec CLI to run audit tests against targets using SSH, |windows remote management|, locally, or on |docker| containers.
+
+Common Options
+=====================================================
+The following options may be used with any of the InSpec CLI subcommands:
+
+``-b``, ``--backend``
+   Specify the backend. Possible values: ``docker``, ``local``, ``ssh``, or ``winrm``.
+
+``--disable_sudo``
+   Use to prevent remote scanning via sudo. Default value: ``false``.
+
+``--host``
+   The remote host to be tested.
+
+``--key``
+   The login key or certificate file required for remote scanning.
+
+``--password``
+   The login password for remote scanning.
+
+``--path``
+   The login path used to connect to the target.
+
+``--port``
+   The port over which remote scanning will occur.
+
+``--self_signed``
+   Use to allow remote scanning with self-signed certificates for |windows remote management| targets.  Default value: ``false``.
+
+``--ssl``
+   Use to require transport-layer encryption via SSL for |windows remote management| targets. Default value: ``false``.
+
+``--sudo_options``
+   Additional options that may be required by the sudo password for remote scanning. Default value: ``''``.
+
+``--sudo_password``
+   The sudo password, if required.
+
+``-t``, ``--target``
+   The URI for the target of a remote scan, preceded by the target's backend. For example: ``backend://user:pass@host:port``, where ``backend`` is one of ``docker``, ``local``, ``ssh``, or ``winrm``.
+
+``--user``
+   The login user for remote scanning.
+
+
+
+check
+=====================================================
+Use ``inspec check`` to run all tests at the specified path.
+
+Syntax
+-----------------------------------------------------
+This subcommand has the following syntax:
+
+.. code-block:: bash
+
+   $ inspec check PATH (options)
+
+where:
+
+* ``PATH`` is the location against which tests are run
+
+
+
+detect
+=====================================================
+Use ``inspec detect`` to detect the platform for the target.
+
+For example, if the configuration on the target is:
+
+.. code-block:: bash
+
+   id=$( docker run -dti ubuntu:14.04 /bin/bash )
+
+the following command:
+
+.. code-block:: bash
+
+   $ inspec detect -t docker://$id
+
+will return:
+
+.. code-block:: javascript
+
+   {"family":"ubuntu","release":"14.04","arch":null}
+
+
+exec
+=====================================================
+Use ``inspec json`` to read all tests at the specified path, and then generate a |json| profile to standard output (stdout) or printed to the command shell.
+
+Syntax
+-----------------------------------------------------
+This subcommand has the following syntax:
+
+.. code-block:: bash
+
+   $ inspec exec PATHS (options)
+
+where:
+
+* ``PATHS`` is one (or more) locations against which tests are run
+
+Options
+-----------------------------------------------------
+This subcommand has additional options:
+
+``--id``
+   Use to attach a profile identifier to all test results.
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this subcommand.
+
+**Run a test locally**
+
+.. code-block:: bash
+
+   $ inspec exec test.rb
+
+**Run a test on a remote host using SSH**
+
+.. code-block:: bash
+
+   $ inspec exec test.rb -t ssh://user@hostname
+
+**Run a test on a remote host using WinRM**
+
+.. code-block:: bash
+
+   $ inspec exec test.rb -t winrm://Administrator@windowshost --password 'password'
+
+**Run a test against a Docker container**
+
+.. code-block:: bash
+
+   $ inspec exec test.rb -t docker://container_id
+
+
+
+help
+=====================================================
+Use ``inspec help`` to print help for the |ctl inspec| from the command shell.
+
+
+
+json
+=====================================================
+Use ``inspec json`` to read all tests at the specified path, and then generate a |json| profile to standard output (stdout) or printed to the command shell.
+
+Syntax
+-----------------------------------------------------
+This subcommand has the following syntax:
+
+.. code-block:: bash
+
+   $ inspec json PATH (options)
+
+where:
+
+* ``PATH`` is the location against which tests are run
+
+Options
+-----------------------------------------------------
+This subcommand has additional options:
+
+``--id``
+   Use to attach a profile identifier to all test results.
+
+``-o``, ``--output``
+   Use to generate the |json| profile to standard output (stdout).
+
+``-p``, ``--print``
+   Use to print the |json| profile to the command shell.
+
+
+
+shell
+=====================================================
+Use ``inspec shell`` to open an interactive debugging shell.
+
+
+
+version
+=====================================================
+Use ``inspec version`` to print the version of the InSpec CLI.