website VS runme

Let's jump right into a showcase. A “thank you” goes out to our friends at Buoyant (creators of Linkerd, the open-source service mesh), who openly maintain Linkerd’s docs in Markdown. That same Markdown generates static HTML on their website for developers to copy commands into the terminals. It turns out that Linkerd’s Getting Started Guide makes a great real-world example illustrating how to harness Runme in CI/CD (with minimal to no edits).

Congrats! Save, share, and collaborate with your team. Needless to say, it is also entirely possible to keep the Session Output files offline and local. Read about it here. While you're here, please give Runme a ⭐️ Star on GitHub.

Join us, come hack on Runme, it's OSS and we are always looking for more contributors: https://github.com/stateful/runme

Execute this markdown file https://github.com/stateful/blog-examples/blob/main/gcp-bigquery/README.md with open-source https://runme.dev/

Full install instructions here. Note that runme branch and runme branchGPT are the same.

Now go try it out and help us prioritize! We’d love to hear what you think. If you run into any problems, please don’t hesitate to report them as a GitHub issue or talk to us on Discord.

Read more about the detailed breakdown of above's line items at https://www.stateful.com/blog/runme-road-to-reliable-docs as well as GitHub Projects boards to track progress. ETA for v1.0 is planned for February/March 2023.

Using a simple rdme run you can run command blocks (check out the tab completion too) without much fuzz (as illustrated above making a sample commit to trigger the git-pre-commit hook). For a simple CLI tool, we have been pleasantly surprised at how natural the experience feels for interacting with tasks (if you like the terminal). You can find some additional examples inside of rdme’s repo.