From cca75c5e8ccb8e6d5aa65035acf1935c389a9cbd Mon Sep 17 00:00:00 2001 From: Christoph Hartmann Date: Tue, 1 Dec 2015 11:19:04 +0100 Subject: [PATCH] align cli documentation with cli --- bin/inspec | 6 +++--- docs/ctl_inspec.rst | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/bin/inspec b/bin/inspec index b8f07bc24..cb0d5111b 100755 --- a/bin/inspec +++ b/bin/inspec @@ -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 diff --git a/docs/ctl_inspec.rst b/docs/ctl_inspec.rst index 958257153..7ee72bea6 100644 --- a/docs/ctl_inspec.rst +++ b/docs/ctl_inspec.rst @@ -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 -----------------------------------------------------