DEV Community

Cover image for Run your README.md like a notebook in VS Code

Run your README.md like a notebook in VS Code

Sebastian Tiedtke on October 20, 2022

💡 TLDR; Runme's project website's got the cliff notes for you: https://runme.dev/ In our ongoing efforts to make documentation more reliable and...
Collapse
 
sinewalker profile image
Mike Lockhart

This is super exciting! I often find myself wishing that I could use Jupyter Notebooks in other contexts where the project isn't really using Python/R and is more about system administration, installing toolchains, or setting up development servers or workstations. In those situations, installing Python/Jupyter and a kernel and so on just to run a shell blob is overkill.

RUNME is an ideal solution here, and brings us back towards literate computing for broader devops.

Collapse
 
sourishkrout profile image
Sebastian Tiedtke

Author here: Thanks, Mike! Let us know how it goes and don't hesitate to report bugs you'll run into. I'd be curious to hear more about your use-cases if you can spare a few minutes (promise, i'll keep it light). Please let me know!

Collapse
 
sirajulm profile image
Sirajul Muneer

Wow! This is really exciting piece of code! I would love to try it this week itself. Just curious to know how will it support interpolation for env variables if I want to pass in some secret for example for .env file or something like that? Or even a user input?

Collapse
 
sourishkrout profile image
Sebastian Tiedtke

Hi Sirajul, author here. Great question. In the current release, you can leverage export VAR_X_1="default" to prompt users and have them confirm the value, more details here: github.com/stateful/vscode-runme#e.... It's flexible enough for this early stage but does not mirror sourcing files into the ENV etc yet. This is an area we're working on improving and I'd love to hear your feedback when you get a chance to use Runme this week. Let us know what you're running up against so we can put it on the roadmap! Thank you.

Collapse
 
shmuelhizmi profile image
shmuelhizmi

This is awesome

Collapse
 
sourishkrout profile image
Sebastian Tiedtke

Thanks, we appreciate it!

Collapse
 
rnian profile image
Nan

cool~

Collapse
 
sourishkrout profile image
Sebastian Tiedtke

Let us know how it goes for you. Also check out the project's website: runme.dev/

Collapse
 
ravidsinghbiz profile image
Ravi D. Singh

This is pretty cool - Need to try it myself and let you know.

Collapse
 
sourishkrout profile image
Sebastian Tiedtke

Very curious to see how it goes for you. Please send me an email or find us on Discord! Thanks Ravi.

Collapse
 
vinceamstoutz profile image
Vincent Amstoutz • Edited

I tried your extension after seeing this post and it's a great tool so I'll give you a 5 star rating on VS Code marketplace! I hope you a successful continuation for this clever and useful project.

Is it planned to make an extension for Jetbrains (PHPStorm, Webstorm etc)?

Collapse
 
sourishkrout profile image
Sebastian Tiedtke

Hi Vincent, author here, thanks for the praise! Much appreciated.

Are you a user of both VS Code and Jetbrains IDEs? We are working on what's next for Runme and I'd very much encourage you to create a feature request here please: github.com/stateful/vscode-runme/i...

Runme's roadmap will likely be focus on strengthening its foundation first before broadening to other IDEs. However, we are very much welcoming community input.

Thank you!

Collapse
 
vinceamstoutz profile image
Vincent Amstoutz

Hi Sebastian!

On personal projects I use VS Code (for licensing reasons) and on professional projects I use as soon as possible the JetBrains IDEs for their powerful integrations which save me a lot of time.

I understand perfectly your roadmap and there is no problem it's already a huge work!
I keep this in the back of my mind if I found a PR or something like that that can help you and your team.

Have a good dev session!

Collapse
 
onionhammer profile image
Erik O'Leary

What about PowerShell on NOT windows? It's a cross platform shell

Collapse
 
sourishkrout profile image
Sebastian Tiedtke

Hi Erik, author here, what platform are you using PowerShell on? Linux?

Would you mind creating a feature request ticket here please github.com/stateful/vscode-runme/i...? Adding as much detail as possible. Thank you!

Since Runme is in its infancy, we wanted to focus on a few features and do them well, hence shell-only support in this release. It does, by no means, mean that PowerShell with or without Windows can not be on Runme's roadmap.

Thanks for the feedback!