Skip to content

About

Step-by-step wizard for runnable guides: a plain Markdown format that humans and AI can write, and a desktop player that shows each step, explains why, and runs the scripts with one click.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

RunbookWizard

A step-by-step wizard for procedures (setup, install, configuration). It shows each step with its explanation, shows the exact command, runs script steps with one click and tells you what happened and why.

The core idea is one unified format for guides that a person can hand-write and an AI can generate: Markdown with YAML frontmatter (*.runbook.md) or JSON (*.runbook.json), validated against one JSON Schema. RunbookWizard is the reference player for it.

RunbookWizard playing the hello-world guide: a finished step with its explanation, the command with an editable parameter field, the result and the output

Guide content is untrusted input: nothing runs without a click and the exact command is always shown first.

Build and test

dotnet build RunbookWizard.slnx
dotnet test RunbookWizard.slnx
dotnet run --project src/RunbookWizard.App -- docs/examples/hello-world.runbook.md

RunbookWizard --health prints the health JSON (status, version, name); RunbookWizard <guide> opens a guide. UI verification uses the shared automation channel, see CLAUDE.md.

License

Licensed under the Apache License 2.0.

About

Step-by-step wizard for runnable guides: a plain Markdown format that humans and AI can write, and a desktop player that shows each step, explains why, and runs the scripts with one click.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages