Runbooks
Operations docs you can actually run
A runbook is a Markdown file of steps, with each ```http block turned into a step with its own Run button. The explanation sits right next to the requests, so you never need the instructions open alongside.
Confirmations
Asks before the risky steps
Mark a step with @reqjet.confirm and it asks before it runs, with the values filled in, so "Publish release 2.4.0 to every customer?" means what it says.
- Captured values from one step (
@reqjet.capture) feed the next, and show in the page's text. - Nothing runs behind your back. A step that needs a value that isn't known yet stops and says so.
Waiting for jobs
Polls until the job is done
@reqjet.until repeats a request until a condition holds: a reindex finishing, a deployment going green, a build completing. @reqjet.fail-if stops straight away on an error, and @reqjet.give-up-after sets a time limit.
- Resumable. Progress is saved as you go, so a long operation can carry on after a restart.
- Run all goes from the first step not yet done and stops at a failure or a "no".
Plain Markdown
Still reads fine on GitHub
A runbook is ordinary Markdown, so it renders properly on GitHub and in VS Code and lives in the repository with the code it operates. Any .md file with an ```http block shows up in the tree as a runbook.
```inputsblocks become input boxes, with a description and default for each.- [ ]items become checkboxes that are remembered.- Prefer code? The same steps can be a script file that calls
send("name"), with loops and branches. See Scripts.
## 1. Create the draft ```http # @name createDraft # @reqjet.capture draftId = body.$.id POST {{baseUrl}}/posts ``` The draft is **{{draftId}}**. ## 3. Wait for the build ```http # @reqjet.until body.$.completed == true # @reqjet.every 2s # @reqjet.give-up-after 2m GET {{baseUrl}}/builds/{{draftId}} ```
More features
There's more where that came from
Try it on your own requests
Free for Windows, macOS and Linux, and it opens the .http files you already have.