https://github.com/cmorten/readme-runner
Run code snippets from a README (or any other file).
https://github.com/cmorten/readme-runner
deno deno-module denoland readme
Last synced: about 1 month ago
JSON representation
Run code snippets from a README (or any other file).
- Host: GitHub
- URL: https://github.com/cmorten/readme-runner
- Owner: cmorten
- Created: 2020-06-12T22:03:36.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-01-28T09:46:46.000Z (over 2 years ago)
- Last Synced: 2025-04-01T17:54:51.714Z (about 1 year ago)
- Topics: deno, deno-module, denoland, readme
- Language: TypeScript
- Size: 12.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# readme-runner
Run code snippets from a README (or any other file).
## Usage
As a minimum you need to provide the `--allow-net`, `--allow-read` and `--allow-write` permission flags.
You can then run the readme-runner as follows:
```bash
deno run --allow-net --allow-read --allow-write --reload https://raw.githubusercontent.com/asos-craigmorten/readme-runner/main/mod.ts
```
For example, this runs an example from the Pogo web frameworks README which runs a server on .
```bash
deno run --allow-net --allow-read --allow-write --reload https://raw.githubusercontent.com/asos-craigmorten/readme-runner/main/mod.ts https://raw.githubusercontent.com/sholladay/pogo/master/README.md 31 39
```
Take care not to execute any parts of READMEs that you have not first checked are safe to do so.
Start and end line numbers start from 1.