Live data from Hacker News

Runme – Interactive Runbooks Built with Markdown

runme.dev

11–20 of 47 posts

Re: Runme – Interactive Runbooks Built with Markdown

#11

How is this better than actual Jupiter?

There are actually many differences. We focus more on operational tasks, and allow cells to contain code from a number of programming languages in addition to python. In fact most folks are using Runme to make executing runbooks full of bash commands a better experience.

Re: Runme – Interactive Runbooks Built with Markdown

#12
GNU Emacs has this feature built-in as part¹ of Org mode².

I have recently started using it at work, including extracting shell snippets into script files³ that are tested and reused in CI.

A frontend like this would be nice for bringing the interactivity to users of other editors!

--

1: https://orgmode.org/worg/org-contrib/babel/

2: https://orgmode.org/

3: https://orgmode.org/manual/Extracting-Source-Code.html

Re: Runme – Interactive Runbooks Built with Markdown

#13

I made a VSCode extension to do this but never published it. All it required was that md code snippets had a language annotation/label, and that you either had a default interpreter pre-installed or could configure an interpreter. I still have no clue why I did it NOR why I never published it.

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

Re: Runme – Interactive Runbooks Built with Markdown

#14

It's like a specialised case of org-babel for the masses. Anyone with emacs can do this today, for free. The huge caveat is that it requires emacs. Where this tool shines, is that it's a superset of markdown, and thus not tied to any particular editor.

I haven't played with any of the alternative/independent implementations of Org mode but there are several out there¹. It would be cool to use one as the basis for a tool like Runme, or a collection of plugins for other editors.

--

1: https://orgmode.org/worg/org-tools/index.html

Re: Runme – Interactive Runbooks Built with Markdown

#15

I like the idea of this conceptually but it feels that I could do all this with github actions. Is it the interactivity and ease of changing the script that is the selling point here?

We've seen that it's not unusual in operations for folks to walk through runbooks running commands that require small (but important) amounts of human input. Runme makes that experience considerably better by utilizing the markdown that's already there and allowing for behavioral configuration (user prompts, process execution, language interpreter etc). But you can also name, and run groups of cells/commands to streamline your workflows.

Re: Runme – Interactive Runbooks Built with Markdown

#16

How is this better than actual Jupiter?

I wouldn't squirrel my documentation away in an ipynb file. So even though I'd like to use notebooks as runbooks, Jupyter just isn't the right solution for that. This could be a great tool for when you want to augment markdown documentation with runnable snippets. I really like this idea, it gives off literate programming[0] vibes. [0]: http://literateprogramming.com/

You nailed it, thanks for calling that connection out. We were very much inspired by literate programming.

Re: Runme – Interactive Runbooks Built with Markdown

#18
post #11

How is this better than actual Jupiter?

There are actually many differences. We focus more on operational tasks, and allow cells to contain code from a number of programming languages in addition to python. In fact most folks are using Runme to make executing runbooks full of bash commands a better experience.

Ok, so from the front page I got the impression it was only bash. I'm hitting cloud APIs via python so Jupyter works for that, and I'm using the python to ssh into systems and run bash there. The two missing things from Jupyter are 1. ssh-ing to remote hosts and running shell scripts (we do it with a bunch of code) and 2. running cells concurrently. But python is a hard requirement.

Re: Runme – Interactive Runbooks Built with Markdown

#20
post #11

Earlier quoted context omitted.

There are actually many differences. We focus more on operational tasks, and allow cells to contain code from a number of programming languages in addition to python. In fact most folks are using Runme to make executing runbooks full of bash commands a better experience.

Ok, so from the front page I got the impression it was only bash. I'm hitting cloud APIs via python so Jupyter works for that, and I'm using the python to ssh into systems and run bash there. The two missing things from Jupyter are 1. ssh-ing to remote hosts and running shell scripts (we do it with a bunch of code) and 2. running cells concurrently. But python is a hard requirement.

I've just added the currently supported languages you can execute to runme.dev in the features section (Javascript, Typescript, Shell, Lua, Perl, Python and Ruby for now). Also, the Runme CLI (https://github.com/stateful/runme) also supports running cells in parallel with `runme run -all -p`.

We'd be interested to know how we can help Runme satisfy your use cases, join us on Discord! https://discord.gg/runme

Post reply on HN