https://github.com/mprojectscode/obsidian-script-runner-plugin
https://github.com/mprojectscode/obsidian-script-runner-plugin
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mprojectscode/obsidian-script-runner-plugin
- Owner: mProjectsCode
- License: gpl-3.0
- Created: 2022-11-14T11:33:52.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T17:46:50.000Z (over 3 years ago)
- Last Synced: 2025-04-03T15:01:43.934Z (about 1 year ago)
- Language: TypeScript
- Size: 700 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Obsidian Script Runner Plugin
A plugin to run scripts directly in obsidian.
To use the plugin, create a code block with `runner-[code language goes here]` as the language.
The first line must be a comment with the content `script-id: [UUID goes here]`.
To generate UUIDs, the plugin offers the command `Generate UUID`.
Example with js (replace single quotes with backticks for the code block)
```
'''js-runner
// script-id: [UUID goes here]
[code goes here]
'''
```
### Features
- real time console output
- real time console input (for scripting languages that support it)
- termination of the script (for scripting languages that support it)
- configurable execution path (file relative and vault relative) (for scripting languages that support it)
- persistent console (shows the output from the last time the script was run, even after obsidian restart)
### Language support
#### Current
- js
- python
- octave (.m)
#### Planned
- bash
### How it works
The plugin works by creating a file out of the code block and then running the script from the command line.