Skip to main content

Runme on Windows

Runme badge

To use Runme on a Windows machine, you have to use the Windows Subsystem for Linux 2 (WSL 2). Currently, Runme is built on Cloud-native Shell Kernel with a notebook, editor, terminal, and CLI interface, With WSL 2 you can get the full Runme exprience on your Windows machine. WSL 2 allows you to run a full Linux kernel inside a lightweight utility virtual machine (VM) on Windows 10 and Windows 11.

In this section, we will explore the various steps required to get Runme working on your Windows machine.

Requirements​

To get started, you need to :

Once all the requirements are fulfilled, the next thing you need to do is start your WSL. To learn all about starting WSL, check out this article.

How to Install Runme Extension on VS Code on Windows​

In this section, we will provide a step-by-step guide to help you install the Runme VS Code extension on your Windows machine.

To get Runme installed in VS Code on your Windows machine, follow the steps below:

  1. Open up VS Code on your local machine.
  2. Navigate to the Extension tab, which can be located on the dashboard on your left.

runme extension

  1. In your search bar, type "Runme". This will display the Runme Notebook extension.

runme extension

  1. Now click on Install to install the Notebook extension.

Setting up Runme on WSL​

At this point, you should have WSL set up on your local Windows machine. As stated earlier, Runme is built on Cloud-native Shell Kernel. WSL helps you get the full experience of Runme on your Windows machine.

To set up Runme on WSL, follow the steps below:

  • Step One

In your VS Code, press F1. This will open up a dashboard containing a list of configuration/setup options. Select Connect to WSL.

runme on wsl

Alternatively, you can click on the button at the bottom left side of your VS Code dashboard, as shown in the image below, and you will be prompted with the same dashboard options.

vs code dashboard

  • Step Two

After connecting to your server using WSL, the next step is to install the Runme extension on the remote server so you can use it as you like.

wsl windows

  • Step Three

Use the File menu to open your folder. If you already have a folder open, you can also use the WSL: Reopen Folder in WSL command. You will be prompted which “Distro" to use.

Running Runme works on Windows​

This section will explore how Runme works in VS Code on Windows.

  • Create a Markdown file and click the “+Code” button to create a code cell for your scripts or command.

runme +code

  • Enter your command into the code cell and click Run.

click run

  • If you want to configure your code cell before running, click the configure button.

runme configure

Runme CLI with WSL​

You can also access Runme from your CLI with WSL on your Windows machine. To use the Runme CLI on your WSL server, follow these steps:

  1. Connect to WSL Open your terminal and run the command below:
wsl

This will connect your machine to your WSL server.

  1. Install Runme CLI

After successfully connecting to the WSL server, the next step is to install Runme CLI on your local machine.

To do this, run the command below:

brew install runme
  1. Run tasks

At this point, you have connected to the WSL server and installed Runme CLI. You can run any task of your choice within your CLI. To do this, use runme <command> to execute tasks defined in the Markdown .md files.

runme cli

For more details on how to use the Runme CLI, refer to the Runme CLI documentation.

Additional Resources​

To learn more about how Runme works on several other client interfaces, see these resources: