runbook-executor
npx skills add https://github.com/jondotsoy/skills --skill runbook-executor
Agent 安装分布
Skill 文档
Overview
This skill helps execute runbooks and document the execution with timestamped evidence. When a user runs through a runbook’s steps, this skill generates a structured evidence file that captures what actually happened during execution, including results, deviations, issues, and validations.
Evidence files are stored alongside the runbook in timestamped directories, allowing multiple executions to be tracked over time without overwriting previous evidence.
Configuration
Evidence location pattern: <runbook-path>/evidence/<YYYY-MM-DD-HH-MM>/result.md
Example: ./runbooks/user-login-flow/evidence/2026-01-31-14-30/result.md
Evidence Structure
Each evidence file documents:
- Execution Summary: Status, duration, environment, executor
- Technical Requirements Verification: Confirmation of prerequisites
- Step-by-Step Execution: Actual commands run, results obtained, timestamps
- Validation Results: Database checks, API responses, UI verifications
- Issues Encountered: Problems found and their resolutions
- Deviations: Any differences from the documented runbook
- Recommendations: Suggestions for improving the runbook
- Conclusion: Overall assessment and follow-up actions
Instructions
When asked to execute a runbook and document evidence:
- Run the evidence creation script:
./runbook-executor/scripts/create-evidence.sh <runbook-path> - Follow the runbook steps in
<runbook-path>/STEPS.md - Document each step’s execution in the generated evidence file
- Capture actual commands, outputs, and results
- Note any deviations or issues encountered
- Complete all validation sections
- Add screenshots or logs to the evidence directory if needed
- Write the conclusion with overall assessment
When asked to review past executions:
- Run the list script:
./runbook-executor/scripts/list-evidence.sh <runbook-path> - Review the list of executions ordered by date (newest first)
- Open the relevant
result.mdfile from the desired timestamp
Examples
Execute a runbook and create evidence:
./runbook-executor/scripts/create-evidence.sh runbooks/user-login-flow
Execute an API testing runbook:
./runbook-executor/scripts/create-evidence.sh runbooks/api-payment-flow
List all evidence executions for a runbook (newest first):
./runbook-executor/scripts/list-evidence.sh runbooks/user-login-flow
Resources
- Template:
assets/evidence-template.md - Creation script:
scripts/create-evidence.sh - List script:
scripts/list-evidence.sh