Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document InSpec Shell #805

Closed
chris-rock opened this issue Jun 27, 2016 · 2 comments · Fixed by #925
Closed

Document InSpec Shell #805

chris-rock opened this issue Jun 27, 2016 · 2 comments · Fixed by #925
Labels
Aspect: Docs Write the Fine Manual
Milestone
0.31.0

Comments

@chris-rock
Copy link
Contributor

Description

The inspec shell command is not properly documented. It should document the basic commands to interact with local and remote systems.
@chris-rock chris-rock added the Aspect: Docs Write the Fine Manual label Jun 27, 2016
@chris-rock chris-rock added this to the 1.0.0 milestone Jul 26, 2016
@chris-rock chris-rock modified the milestones: 0.30.0, 1.0.0 Aug 8, 2016
@chris-rock
Copy link
Contributor Author

The built-in help may be good, but users look for documentation in https://github.com/chef/inspec/tree/master/docs, we may be able to auto-generate those form the built-in help

@chris-rock chris-rock modified the milestones: 0.30.0, 0.31.0 Aug 12, 2016
@chris-rock
Copy link
Contributor Author

We should document:

  • What is the inspec shell?
  • How do I start the shell? (with examples)
  • Remote shell (connect to remote machines for debugging)
  • Available commands within the shell
  • Examples to execute a describe block

@ksubrama ksubrama mentioned this issue Aug 18, 2016
Merged
chris-rock added a commit that referenced this issue Aug 19, 2016
@chris-rock
Merge pull request #925 from chef/ksubrama/docs
64964aa 
inspec shell documentation - Fix #805
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Aspect: Docs Write the Fine Manual
Projects
None yet
Milestone
0.31.0
Development

Successfully merging a pull request may close this issue.

inspec shell documentation - Fix #805 inspec/inspec
2 participants
@chris-rock @ksubrama