Speedrun – Markdown to build tools (OSS)

Hacker News

Share card

Speedrun – Markdown to build tools (OSS)

You go to the docs to do something but there's no button to click on to do it. Further, there's all that nonsense of getting credentials, gathering and formatting inputs and finding and replacing text. Enter Speedrun, simple markdown that lets you build tools right into your documentation where they belong. It powers up your README's, runbooks and documentation with the ability to prompt for inputs, run JavaScript, get temporary AWS credentials and reference configuration. Now instead of merely telling your users what to do, they can solve their exact problem with a click. Think of it like a Jupyter notebook but on top of GitHub markdown. In its current incarnation, it runs as a TamperMonkey script that finds Speedrun blocks in your GitHub repo and lights them up. It can be used to wrap a command line with a ui, federate to an exact location in the AWS console, as a ui for authorizing and invoking an AWS Lambda or Step Function and many other use cases like building a SQL statement. The neat thing is that you aren't really building new tools, you're speedrunning the tools you already use by wrapping them to make them faster, safer and easier. And since it's markdown, you can build a tool your team can instantly use in less time than it takes to complain about the problem. Here's an example that will allow only authorized users to get temporary credentials and invoke an AWS Lambda function with some json it builds based on the name it prompts you for. ``` #!lambda {functionName:"HelloWorldService"} { "name": "~~~Name {default:'Samuel L. Jackson'}~~~" } ``` You can see the above example in action, see the sizzle reel with more use cases and play around in my AWS accounts with the live demo at the website: https://speedrun.cc The script is licensed under the MIT license and it's the perfect time to try it. From now until January 15, 2024, I'm running a fun contest called "Done before the bass drops." You'll use Speedrun to speedrun AWS in less than 90 seconds while EDM plays in the background and you need to be "Done before the bass drops."