mirror of
https://github.com/inspec/inspec
synced 2024-11-23 21:23:29 +00:00
Merge pull request #278 from chef/chris-rock/optimize-cli-help
align cli documentation with cli
This commit is contained in:
commit
67fc932b3a
2 changed files with 4 additions and 4 deletions
|
@ -38,7 +38,7 @@ class InspecCLI < Thor
|
||||||
desc: 'Allow remote scans with self-signed certificates (WinRM).'
|
desc: 'Allow remote scans with self-signed certificates (WinRM).'
|
||||||
end
|
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,
|
option :id, type: :string,
|
||||||
desc: 'Attach a profile ID to all test results'
|
desc: 'Attach a profile ID to all test results'
|
||||||
option :output, aliases: :o, type: :string,
|
option :output, aliases: :o, type: :string,
|
||||||
|
@ -59,7 +59,7 @@ class InspecCLI < Thor
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc 'check PATH', 'verify test structure in PATH'
|
desc 'check PATH', 'verify all tests at the specified PATH'
|
||||||
def check(path)
|
def check(path)
|
||||||
o = options.dup
|
o = options.dup
|
||||||
o[:logger] = Logger.new(STDOUT)
|
o[:logger] = Logger.new(STDOUT)
|
||||||
|
@ -67,7 +67,7 @@ class InspecCLI < Thor
|
||||||
exit 1 unless profile.check
|
exit 1 unless profile.check
|
||||||
end
|
end
|
||||||
|
|
||||||
desc 'exec PATHS', 'run all test files'
|
desc 'exec PATHS', 'run all test files at the specified PATH.'
|
||||||
option :id, type: :string,
|
option :id, type: :string,
|
||||||
desc: 'Attach a profile ID to all test results'
|
desc: 'Attach a profile ID to all test results'
|
||||||
target_options
|
target_options
|
||||||
|
|
|
@ -51,7 +51,7 @@ The following options may be used with any of the InSpec CLI subcommands:
|
||||||
|
|
||||||
check
|
check
|
||||||
=====================================================
|
=====================================================
|
||||||
Use ``inspec check`` to run all tests at the specified path.
|
Use ``inspec check`` to verify all tests the specified path.
|
||||||
|
|
||||||
Syntax
|
Syntax
|
||||||
-----------------------------------------------------
|
-----------------------------------------------------
|
||||||
|
|
Loading…
Reference in a new issue