This plugin allows you to execute code snippets in code blocks in your notes. The plugin adds a 'run' button for code blocks in supported languages. Clicking them results in the code of the block being executed. After the execution the result of the execution is showed. An interactive input element is created when your code snippets reads expects user input.

The result is shown only after the execution is finished. It is not possible to enter text on the command line into the executed program now.

The following languages are supported: C, CPP, Dart, Golang, Groovy, Kotlin, Java, JavaScript, TypeScript, Lean, Lua, CSharp, Prolog, Rust, Python, R, Ruby, Wolfram Mathematica, Haskell, Scala, Racket, F#, Batch, Shell & Powershell, Octave, and Maxima.

Python, Rust, and Octave support embedded plots. All languages support "magic" commands that help you to access paths in obsidian or show images in your notes.

You can create code blocks that are executed before or after each code block of the same language and define global code injections.

Take a look at the changelog to see what has changed in recent versions.

function hello(name) {
	console.log(`Hello ${name}!`);
}

hello("Bob")

let message: string = 'Hello, World!';
console.log(message);  

Console.WriteLine("Hello, World!");  

void main() {
  print("Hello World");
}

def hello(name):
	print("Hello", name)

if __name__ == "__main__":
	hello("Eve")

import seaborn as sns
import matplotlib.pyplot as plt
sns.set_style("darkgrid")
iris = sns.load_dataset('iris')
sns.FacetGrid(iris, hue ="species", height = 5)
		.map(plt.scatter, 'sepal_length', 'petal_length')
		.add_legend()

plt.show()

hello <- function(name){
	print(paste("Hello", name, sep = " "))
}

hello("Bob")

y = c(12, 15, 28, 17, 18)
x = 1:length(y)
plot(x, y, type="l")

public class HelloWorld {
	public static void main(String[] args) {
		System.out.println("Hello World!");
	}
}

print('Hello, World!')

def main : IO Unit :=
  IO.println s!"Hello, World!"

#eval main

#include <iostream>
#include <string>

using namespace std;

void hello(string name) {
	cout << "Hello " << name << "!\n";
}

hello("Alice);

#include <iostream>

void main() {
	std::cout << "Hello, World!" << std::endl;
}

#include <stdio.h>

printf("Hello, World!");

#include <stdio.h>

int main() {
	printf("Hello, World!");
	return 0;
}

echo "Hello World!"
ls -la

echo "Hello World!"

ECHO Hello World!

likes(john, pizza).
likes(john, cheese).
likes(jane, beer).

% query
likes(john, X).

def hello(name){  
	println "Hello ${name}!" 
}  

def helloClosure = {  
	println "Hello ${it}!" 
}  
  
hello("Bob")
  
helloClosure "Bob"

package main

import "fmt"

func main() {
	fmt.Println("Hello World")
}

fn main() {
	println!("Hello World");
}

hello(name: String) {
	println("Hello $name!")
}

hello("Bob")

mySum:: Num a => a -> a -> a
mySum a b = a+b

println("Hello, World!")

"Hello, world!"

puts "Hello, World!"

exp(i*pi)

x = -10:0.1:10;
plot (x, sin(x));

integrate(x,x);
plot2d(sin(x), [x,0,%pi]);

Squiggle: For Squiggle support take a look at the Obsidian Squiggle plugin by @jqhoogland.

Support for the following is planned:

• Matlab
• Julia Lang

Open for suggestions.

Magic commands are some meta commands that can be used in the code block. They are processed by the plugin before the source code is executed.

The following magic commands are supported:

• @vault_path: Inserts the vault path as string (e.g. "/User/path/to/vault")
• @vault_url: Inserts the vault url as string. (e.g. "app:https://local/path/to/vault")
• @note_path: Inserts the vault path as string (e.g. "/User/path/to/vault/Note.md")
• @note_url: Inserts the vault url as string. (e.g. "app:https://local/path/to/vault/Note.md")
• @title: Inserts the note title as string.
• @show(ImagePath): Displays an image at the given path in the note.
• @show(ImagePath, Width, Height): Displays an image at the given path in the note.
• @show(ImagePath, Width, Height, Alignment[center|left|right]): Displays an image at the given path in the note.
• @html(HtmlSource): Displays HTML in the note

(@show(...) and @html(...) are only supported for JavaScript and Python yet.) (The old commands @note and @vault are still supported, but may be removed in the future.)

Examples for the magic commands with Python:

print("Vault path:", @vault_path)
print("Vault url:", @vault_url)

print("Note path:", @note_path)
print("Note url:", @note_url)

print("Note title:", @title)

@show("image.png")
@show("image.png", 100, 100)
@show("https://upload.wikimedia.org/wikipedia/commons/d/de/TestScreen_square.svg", 10%, 10%, "center")

@html("<h1>HTML Caption</h1>")
@html('''
<svg width="100%" height="100%" viewBox="0 0 600 600" xmlns="https://www.w3.org/2000/svg" xmlns:xlink="https://www.w3.org/1999/xlink">
  <circle cx="300" cy="300" r="250" style="fill:peru;" />
  <circle cx="200" cy="250" r="50" style="fill:black;" />
  <circle cx="400" cy="250" r="50" style="fill:black;" />
  <circle cx="190" cy="230" r="20" style="fill:white;" />
  <circle cx="390" cy="230" r="20" style="fill:white;" />
  <circle cx="250" cy="400" r="85" style="fill:saddlebrown;" />
  <circle cx="350" cy="400" r="85" style="fill:saddlebrown;" />
  <ellipse cx="300" cy="380" rx="50" ry="35" style="fill:black;" />
  <ellipse cx="130" cy="100" rx="110" ry="70" style="fill:saddlebrown;"/>
<ellipse cx="470" cy="100" rx="110" ry="70" style="fill:saddlebrown;" />
</svg> 
''')

Try it out yourself!

Adding run- before the language name in the code blocks (as in the example below) renders the code block in the preview already. This allows you to execute the code in the preview.

```run-python
def hello(name):
print("Hello", name)

    if __name__ == "__main__":
        hello("Eve")

Code blocks support specifying additional arguments in the form {key='value', otherkey=['val1', 'val2']}. Add them to code blocks like so:

```python {label='my label'}
print('my labelled code block')
```

Sometimes it is helpful to have code that is executed before or after each other block of the same language. This plugin supports this in a few ways:

All languages have a 'global inject' option in the settings that allows defining code to be added to the top of every single code block on a per-language basis. Code reuse fully works with all languages, and all existing magic commands, including showing images, and inline plot outputs. This can be used to define e.g. often used functions or import your favourite packages or libraries.

You can specify the pre argument to create a block that is executed before each following code block:

```python {pre}
import pandas as pd
```

This code block is added before each python block you define below in the note and import the pandas package.

post blocks work the same way, but the code in post blocks is executed after your other code blocks.

Pre/Post blocks will only apply to code blocks defined below them, and will only apply to code blocks from the same language.

You can also have a pre and post block at the same time by specifying {pre, post}

Note, the pre/post arguments are special in that you don't need to explicitly state a key/value pair, however you can do so if you wish:

{pre} is equivalent to {export='pre'}, {pre, post} is equivalent to {export=['pre', 'post']}.

You can label specific code blocks with the label='string' argument, then import them explicitly in other blocks with the import='string' or import=['string1', 'string2', ...] argument so they aren't automatically imported as with pre / post blocks:

```python {label='block 1'}
print('running block 1')
```

```python {label='block 2'}
print('running block 2')
```

```python {import=['block 1', 'block 2']}
print('should run block 1 and 2')
```

Labelled code blocks will be executed before the code block being run, however after global injects and pre blocks.

In case you want to manually ignore specific exports in a code block like pre / post / global exports, you can do so with the ignore argument that accepts either pre, post, global, an array of any of these 3, or all to ignore all exports:

```python {ignore='all'}
print('should not run any global injects or pre / post blocks')
```

```python {ignore=['global', 'pre']}
print('should not run any pre blocks or global injects')
```

A few languages (currently JS and Python) support Notebook Mode. If a language is using Notebook Mode (configurable in Settings), then all code blocks in a given file will execute in the same environment.

Variables functions, etc. defined in one code block will be available in other code blocks. Code blocks are executed on demand; the order of code blocks in the file does not affect the order in which they are executed:

```js
console.log(f)
```
```js
let f = 3;
```

Running the first code block, then the second, then the first again will give:

Uncaught ReferenceError: f is not defined
undefined
3

To manage the open runtimes for Notebook Mode, you can use the Open Code Runtime Management command in the command palette. From this sidebar window, you can stop kernels. Note: force-stopping requires taskkill on Windows and pkill on Unix. 99% of systems should have these preinstalled: if yours doesn't, please file an issue

This plugin supports customising styles using the Style Settings plugin. It's possible to customise the color of code block outputs and errors.

In your vault go to Settings > Community plugins > Browse and search for "Execute Code". Select the plugin, install it and activate it.

or

Follow this link and click "Open in Obsidian".

To avoid or resolve errors from an incorrect path.

('where' for Mac and Windows) --- (for Linux Users, replace 'where' with 'which')

1. In your terminal, type 'where node'
2. Copy path from terminal ( ex. /opt/homebrew/bin/node )
3. Paste in path under settings ( ex. Node path )

Do not execute code from sources you don't know or code you don't understand. Executing code can cause irreparable damage.

• On Linux, Snap/Flatpak/AppImage installations of Obsidian run in an isolated environment. As such, they will not have access to any of your installed programs. If you are on Linux, make sure to install the .deb version of Obsidian. If your distro isn't compatible with .deb files, you may see issues.
• Missing when run button after switching the theme: Try to close and reopen your notes and wait for a few minutes. It seems like obsidian doesn't call the postprocessors after the theme switch.
• Pre- / Post-blocks may not be executed if the file contains duplicate code blocks.
• In Python, Embed Plots may not be off while Notebook Mode is on

• Notebook Mode similar to Jupyter
• Error warning when the execution fails (e.g. when python isn't installed)
• Test if this plugin works in combination with dataview.

All contributions are welcome. Just create a merge request or email me: tim.wibiral(at)uni-ulm.de

The bullet points in Future Work are a good starting point if you want to help.

_{Made with contrib.rocks.}