Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-11-23 05:03:07 +00:00
Code Issues Projects Releases Packages Wiki Activity

align cli documentation with cli

Browse source
This commit is contained in:
Christoph Hartmann 2015-12-01 11:19:04 +01:00
parent 3d0a1b81d8
commit cca75c5e8c
2 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
bin/inspec
View file

@ -38,7 +38,7 @@ class InspecCLI < Thor
desc: 'Allow remote scans with self-signed certificates (WinRM).'
end
desc 'json PATH', 'read all tests in PATH and generate a JSON profile'
desc 'json PATH', 'read all tests in PATH and generate a JSON summary'
option :id, type: :string,
desc: 'Attach a profile ID to all test results'
option :output, aliases: :o, type: :string,
@ -59,7 +59,7 @@ class InspecCLI < Thor
end
end
desc 'check PATH', 'verify test structure in PATH'
desc 'check PATH', 'verify all tests at the specified PATH'
def check(path)
o = options.dup
o[:logger] = Logger.new(STDOUT)
@ -67,7 +67,7 @@ class InspecCLI < Thor
exit 1 unless profile.check
end
desc 'exec PATHS', 'run all test files'
desc 'exec PATHS', 'run all test files at the specified PATH.'
option :id, type: :string,
desc: 'Attach a profile ID to all test results'
target_options

2
docs/ctl_inspec.rst
View file

@ -51,7 +51,7 @@ The following options may be used with any of the InSpec CLI subcommands:
check
=====================================================
Use ``inspec check`` to run all tests at the specified path.
Use ``inspec check`` to verify all tests the specified path.
Syntax
-----------------------------------------------------