{"id":30193178,"url":"https://github.com/runmedev/runmejs","last_synced_at":"2026-02-15T06:08:17.274Z","repository":{"id":62620363,"uuid":"560550373","full_name":"runmedev/runmejs","owner":"runmedev","description":"A JavaScript module to use Runme in Node.js.","archived":false,"fork":false,"pushed_at":"2025-06-23T20:03:04.000Z","size":958,"stargazers_count":7,"open_issues_count":3,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-10-21T07:43:54.974Z","etag":null,"topics":["markdown","notebook","readme","readmeops","runme","vscode"],"latest_commit_sha":null,"homepage":"https://runme.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/runmedev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","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,"zenodo":null}},"created_at":"2022-11-01T18:40:17.000Z","updated_at":"2025-06-23T20:03:08.000Z","dependencies_parsed_at":"2023-11-14T19:31:22.208Z","dependency_job_id":"76850dee-7054-4fae-8c99-5efc831816c4","html_url":"https://github.com/runmedev/runmejs","commit_stats":{"total_commits":43,"total_committers":3,"mean_commits":"14.333333333333334","dds":0.3023255813953488,"last_synced_commit":"7929e2301c4c748ab93238557cacc7bfc4599347"},"previous_names":["runmedev/runmejs","stateful/runmejs"],"tags_count":49,"template":false,"template_full_name":null,"purl":"pkg:github/runmedev/runmejs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runmedev%2Frunmejs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runmedev%2Frunmejs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runmedev%2Frunmejs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runmedev%2Frunmejs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/runmedev","download_url":"https://codeload.github.com/runmedev/runmejs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runmedev%2Frunmejs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29471198,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-15T05:26:30.465Z","status":"ssl_error","status_checked_at":"2026-02-15T05:26:21.858Z","response_time":118,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["markdown","notebook","readme","readmeops","runme","vscode"],"created_at":"2025-08-13T01:23:05.481Z","updated_at":"2026-02-15T06:08:17.268Z","avatar_url":"https://github.com/runmedev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Runme.js [![Test Changes](https://github.com/runmedev/runmejs/actions/workflows/test.yaml/badge.svg)](https://github.com/runmedev/runmejs/actions/workflows/test.yaml) [![npm version](https://badge.fury.io/js/runme.svg)](https://badge.fury.io/js/runme) [![Join us on Discord](https://img.shields.io/discord/878764303052865537?color=5b39df\u0026label=Join%20us%20on%20Discord)](https://discord.com/invite/BQm8zRCBUY)\n\n\u003e A JavaScript module to use [Runme](https://runme.dev) in Node.js.\n\n_Runme.js_ contains the [Runme CLI](https://github.com/stateful/runme) and allows to access its functionality through a simple JavaScript interface. The CLI binary is downloaded and cached when the interface is first being used.\n\n## Install\n\n### Node.js\n\nInstall the module through NPM:\n\n```sh\n$ npm install runme\n# or Yarn\n$ yarn add runme\n```\n\nYou can also install the package globally and it as a CLI, e.g.:\n\n```sh\nnpm i -g runme\nrunme list\n```\n\nBy default this package downloads the [Runme CLI](https://github.com/stateful/runme) when the interface is used for the first time. You can download it after running `npm install` by setting the `RUNME_DOWNLOAD_ON_INSTALL` environment flag. You can also modify the Runme version that is being installed by setting `RUNME_VERSION`, e.g.:\n\n```sh\nRUNME_DOWNLOAD_ON_INSTALL=1 RUNME_VERSION=1.0.0 npm install runme\nnpx runme --version # prints \"runme version 1.0.0 (adae05c5b75351e9fe82acd595ac8086b6abf19b) on 2023-03-28T20:56:21Z\"\n```\n\n## Usage\n\nThe module exposes the following methods:\n\n### `run`\n\nRun code cells from markdown files:\n\n```javascript {\"name\":\"runExample\"}\nimport { run } from \"runme\";\n\nconst result = await run([\"helloWorld\"]);\nconsole.log(result); // outputs: { exitCode: 0, stdout: 'Hello World\\r\\n', stderr: '' }\n```\n\nRunme can run multiple commands in a single shell session that allows you to keep environment variables around.\n\n```javascript {\"terminalRows\":\"15\"}\nimport { run } from \"runme\";\n\n// execute `echo \"exported FOO=$FOO\"` from markdown code cell with id \"print\"\nconst result = await run([\"export\", \"print\"]);\nconsole.log(result);\n// outputs:\n// {\n//   exitCode: 0,\n//   stdout: ' ►  Running task export...\\n' +\n//     ' ►  ✓ Task export exited with code 0\\n' +\n//     ' ►  Running task print...\\n' +\n//     'exported FOO=bar\\r\\n' +\n//     ' ►  ✓ Task print exited with code 0\\n',\n//   stderr: ''\n// }\n```\n\n## Contributing\n\nSee [CONTRIBUTING.md](./CONTRIBUTING.md) for more information or just click on:\n\n[![Run with Runme](https://badgen.net/badge/Run%20with/Runme/5B3ADF?icon=https://runme.dev/img/logo.svg)](https://runme.dev/api/runme?repository=https%3A%2F%2Fgithub.com%2Fstateful%2Frunmejs.git\u0026fileToOpen=CONTRIBUTING.md)\n\n---\n\n\u003cp align=\"center\"\u003e\n  \u003csmall\u003e\n    Copyright 2025 © \u003ca href=\"http://stateful.com/\"\u003eStateful\u003c/a\u003e – Apache 2.0 License\n  \u003c/small\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frunmedev%2Frunmejs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frunmedev%2Frunmejs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frunmedev%2Frunmejs/lists"}