{"id":14070419,"url":"https://github.com/AlessandroRuggiero/script-launcher","last_synced_at":"2025-07-30T07:33:12.009Z","repository":{"id":144397375,"uuid":"524474191","full_name":"AlessandroRuggiero/script-launcher","owner":"AlessandroRuggiero","description":"An Obsidian plugin that allows you to easily run script written in any language directly from the app","archived":false,"fork":false,"pushed_at":"2023-11-28T08:15:23.000Z","size":171,"stargazers_count":24,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-08-13T07:17:53.401Z","etag":null,"topics":["nodejs","notes","script"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AlessandroRuggiero.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-13T18:10:53.000Z","updated_at":"2024-05-08T06:47:28.000Z","dependencies_parsed_at":null,"dependency_job_id":"f08bf448-5b43-4f7c-9c64-105988cb1256","html_url":"https://github.com/AlessandroRuggiero/script-launcher","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlessandroRuggiero%2Fscript-launcher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlessandroRuggiero%2Fscript-launcher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlessandroRuggiero%2Fscript-launcher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlessandroRuggiero%2Fscript-launcher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlessandroRuggiero","download_url":"https://codeload.github.com/AlessandroRuggiero/script-launcher/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228110234,"owners_count":17871151,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nodejs","notes","script"],"created_at":"2024-08-13T07:07:44.836Z","updated_at":"2025-07-30T07:33:11.470Z","avatar_url":"https://github.com/AlessandroRuggiero.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Script Launcher\nThis is an Obsidian plugin that allows you to easily run script written in any language directly from the app.\n\n## How to use it\n### Adding a new script \nGo in the plugin settings and click the `+` icon\nYou will have to fill in some information about the script you want to add:\n1. `Script name` → the name of the script you want to add (has no influnence on the script itself)\n2. `Script path` → absolute path to the script you want to launch (it can be anything: binary, executable, python script,shell script, bash script ecc...)\n3. `Show on bottom bar` → this is a checkbox, if selected the script will be shown on the bottom bar and clicking it will launch it\n4. `Run on startup` → this is a checkbox, if selected the script will run automatically once Obsidian start up\n5. `Show exit code` → this is a checkbox, if selected the script show the exit code when terminated\n6. `Icon` → is the icon displayed on the bottom bar, if left empty the name will be shown instead\n\n### Deleting a script \nClick the `Delete` button on the script's settings you want to delete \n\n### Launching a script \n\nClick the scipt icon on the bottom bar of the Obsidian app.\nIf the script does not show up as an icon go in the settings and select `Show on bottom bar`\n\nYou can also run the script using the `Run script` Obsidian command, you will be prompted with a list of scripts with a searchbar, selecting a script will run it.\n\n\nThe output of the script will be shown as notices in the Obsidian app.\n\n## Examples \n\n### Google Drive backup \nThis script for example syncs on demand files from all you vaults at the click of a button\n```bash\n (cd $path_to_vaults \u0026\u0026 grive -s $vaults_folder)\n```\n![Gif showing how the example plugin works](https://github.com/AlessandroRuggiero/script-launcher/blob/master/docs/images/launching-scipt-example.gif)\n\nif you want to write a script to backup only the files in your vault you can use the `$1` argument:\nThe plugin passes the path to your vault as the first parameter to the script\n```bash\n (cd $path_to_script \u0026\u0026 grive -s $1)\n```\nThe second parameter passed to the script (`$2`) is the path to the currently open file, if there is no open file an empty string will be returned (`\"\"`)\n\n## How to install it\nRemember to enable [Commpunity Plugins](https://help.obsidian.md/Extending+Obsidian/Community+plugins) in the Obsidian settings.\n### From the Community plugins\nThe best way to install the plugin is through the Obsidian community plugins, just search for `script launcher` and you will immediately find it.\n### Build from source\nFirst clone the repo, then in the repo's folder run\n```bash\n    make build_and_copy vault_path=path_to_your_vault\n```\n\nThis will build the plugin and move the files in the correct folder in your vault to allow you to test it\n\n\n### From a tag\nGo to the most recent tag and download the `script-launcher` zip, unzip it and extract the script-launcher folder (it should contain 3 files: main.js manifest.json and styles.css)\n\nMove this folder into `path_to_your_vault/.obsidian/plugins/` (if the plugins folder is not already there create it)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAlessandroRuggiero%2Fscript-launcher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAlessandroRuggiero%2Fscript-launcher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAlessandroRuggiero%2Fscript-launcher/lists"}