Skip to content

Commit

Permalink
Merge pull request #802 from ChefRycar/rycar/add_inspec_init_doc
Browse files Browse the repository at this point in the history
Updating ctl docs to include the init command
  • Loading branch information
chris-rock authored Jun 21, 2016
2 parents 88cded8 + 820cd1a commit b39170a
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/ctl_inspec.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down

0 comments on commit b39170a

Please sign in to comment.