inspec shell documentation - Fix #805 #925
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Note - this is documenting the shell as of #909. It only makes sense once that goes in. |
| InSpec Shell Usage | ||
| ===================================================== | ||
|
|
||
| The InSpec interactive shell is a pry based REPL that can be used to quickly run InSpec controls and tests without having to write it to a file. Its functionality is similar to ``chef shell`` - it provides a way to exercise the InSpec DSL, its resources, tests and plugins without having to create a profile or write a test file. |
There was a problem hiding this comment.
Can we wrap/fill these lines to a set length? It'll makes diffs easier to read in the future and make it easier to edit in vim/emacs.
There was a problem hiding this comment.
@stevendanna Are you asking for explicit newlines? If I remember correctly, we have not used that so far.
There was a problem hiding this comment.
should we add the link to pry? mabe a link to chef-shell would be cool as well
There was a problem hiding this comment.
@stevendanna I wanted to do that initially but none of the other files did it. I didn't know the exact semantics of rst files - so I just went with what the others were doing.
chris-rock
force-pushed
the
ksubrama/docs
branch
from
9ec3353
to
2b95e87
Compare
ksubrama
force-pushed
the
ksubrama/docs
branch
from
2b95e87
to
39eb356
Compare
chris-rock
force-pushed
the
ksubrama/docs
branch
from
39eb356
to
a957b5c
Compare
chris-rock
force-pushed
the
ksubrama/docs
branch
from
a957b5c
to
6dbea7f
Compare
chris-rock
force-pushed
the
ksubrama/docs
branch
from
6dbea7f
to
ad498e9
Compare
chris-rock
force-pushed
the
ksubrama/docs
branch
from
ad498e9
to
83d9ded
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fixes #805