shelldoc 0.92: Final Call for Testing

Last release candidate adds timeouts, dry-run mode, and graceful cancellation

A photo taken a Musée Picasso, Antibes, France

shelldoc version 0.92 is out. It is the final release candidate before 1.0. This is your last chance to report issues before the stable release.

What’s new in 0.92?

This release adds practical features requested by early adopters:

  • Command timeouts: Use --timeout globally or shelldoctimeout=N per code block to prevent runaway commands from hanging your CI
  • Dry-run mode: shelldoc run --dry-run parses and displays commands without executing them—useful for reviewing what a test run would do
  • Graceful cancellation: CTRL-C now cleanly terminates test runs instead of leaving orphan processes

Help shape 1.0

If you maintain Markdown documentation with shell examples, now is the time to try shelldoc. Run it against your README, tutorial, or installation guide. If something breaks or behaves unexpectedly, open an issue before the 1.0 freeze.

go install github.com/mirkoboehm/shelldoc/cmd/shelldoc@v0.92.0
shelldoc run README.md

What happens next?

Bug reports received before the 1.0 release will be addressed. After 1.0, shelldoc moves to semantic versioning with on-demand releases: every bug fix triggers a patch release, every new feature a minor release.

Feedback and contributions welcome at the GitHub repository.

Mirko Boehm
Mirko Boehm
Open Source Economics & Policy

Economics of Open Source and Intellectual Property