Merge pull request #802 from ChefRycar/rycar/add_inspec_init_doc

Updating ctl docs to include the init command
This commit is contained in:
Christoph Hartmann 2016-06-21 21:31:29 +02:00 committed by GitHub
commit b39170a8d7

View file

@ -171,6 +171,33 @@ Use ``inspec help`` to print help for the |ctl inspec| from the command shell.
init
=====================================================
Use ``inspec init`` to initialize a new inspec profile
Syntax
-----------------------------------------------------
This command has the following syntax:
.. code-block:: bash
$ inspec init profile PROFILE (options)
where:
* ``PROFILE`` is the name of the profile you wish to create
Options
-----------------------------------------------------
This subcommand has additional options:
``--overwrite``
Overwite directory if it exists
``--no-overwrite``
Converse of ``--overwrite``. (default)
json
=====================================================
Use ``inspec json`` to read all tests at the specified path, and then generate a |json| profile to standard output (stdout).