{"id":16328770,"url":"https://github.com/khalidx/runbook","last_synced_at":"2025-10-25T21:30:41.895Z","repository":{"id":39626028,"uuid":"321064564","full_name":"khalidx/runbook","owner":"khalidx","description":"Executable markdown documents that you can run, template, and share!","archived":false,"fork":false,"pushed_at":"2022-05-30T15:05:04.000Z","size":558,"stargazers_count":40,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-11T23:15:47.028Z","etag":null,"topics":["code-blocks","markdown","runbook","runnable"],"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/khalidx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-12-13T12:53:37.000Z","updated_at":"2024-09-23T15:35:59.000Z","dependencies_parsed_at":"2022-08-09T15:09:08.881Z","dependency_job_id":null,"html_url":"https://github.com/khalidx/runbook","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khalidx%2Frunbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khalidx%2Frunbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khalidx%2Frunbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khalidx%2Frunbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/khalidx","download_url":"https://codeload.github.com/khalidx/runbook/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238212347,"owners_count":19434946,"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":["code-blocks","markdown","runbook","runnable"],"created_at":"2024-10-10T23:14:30.992Z","updated_at":"2025-10-25T21:30:41.082Z","avatar_url":"https://github.com/khalidx.png","language":"TypeScript","readme":"# runbook\n\nExecutable markdown documents that you can run, template, and share!\n\n\u003cimg src=\"https://raw.githubusercontent.com/khalidx/runbook/main/img/logo.png\" alt=\"Runbook - Executable markdown documents that you can run, template, and share!\" width=\"250px\"\u003e\n\n[![npm package version badge](https://img.shields.io/npm/v/@khalidx/runbook.svg?style=flat-square)](https://www.npmjs.com/package/@khalidx/runbook)\n[![GitHub last commit badge](https://img.shields.io/github/last-commit/khalidx/runbook.svg?style=flat-square)](https://github.com/khalidx/runbook/commits/main)\n[![GitHub license badge](https://img.shields.io/github/license/khalidx/runbook.svg?style=flat-square)](https://github.com/khalidx/runbook/blob/main/LICENSE)\n\n## quickstart\n\n```bash \"install\"\nnpm install -g @khalidx/runbook\n```\n\nThe [USAGE.md](./USAGE.md) file is a runnable markdown document. Check it for some usage examples.\n\n\u003cimg src=\"https://raw.githubusercontent.com/khalidx/runbook/main/img/screenshot.png\" alt=\"Runbook - Command Line Interface Screenshot\" width=\"800px\"\u003e\n\n## commands\n\n[📂 ls](#runbook-ls) | [🚀 run](#runbook-run) | [🌐 serve](#runbook-serve) | [💁 help](#runbook-help)\n\n### 📂 runbook ls\n\nLists all commands found in documents in the current directory.\n\nIt discovers files that end in `.md`, parses them, and finds\nall fenced code blocks in the file.\n\nIt returns a list of \"commands\", which are any fenced code blocks\nthat are annotated with a language + a name. Check out the\nexamples below.\n\n````markdown\n```bash \"hello\"\necho \"Hello!\"\n```\n\n```bash \"two plus two\"\necho $((2 + 2))\n```\n````\n\nRunning `runbook ls` would output a command list like the following:\n\n```text\ndocument.md | hello\ndocument.md | two plus two\n```\n\nCode blocks that are not annotated with a [supported runtime](USAGE.md#supported-runtimes) and a quoted name\nwill be ignored by runbook.\n\n### 🚀 runbook run\n\nRuns the specified command.\n\nThe command must be specified in a markdown document in the current directory.\n\nFor example, to run the \"hello\" command shown above, type:\n\n```bash\nrunbook run hello\n```\n\n### 🌐 runbook serve\n\nStarts up a server and automatically opens the browser to a page that displays all discovered documentation and commands.\n\n### 💁 runbook help\n\nShows what you can do with the `runbook` CLI.\n\n## features\n\n- define and document reusable commands in your favorite language, with many [currently supported](USAGE.md#supported-runtimes)\n- list all commands found in markdown documents in the current directory with `runbook ls`\n- run a specific command from a document with `runbook run`\n- commands can be templated with arguments using handlebars `{{ }}` syntax\n- commands can be overloaded\n- command suggestions are returned if input doesn't match a command\n- commands are checked for uniqueness (name + arity + args)\n- commands written in `bash` can call other commands\n- commands can be referenced from external files, rather than embedded\n- serve all discovered documentation and commands with `runbook serve`\n- debug logs are written to `~/.runbook/logs/`\n\n## contributing\n\nOpen a GitHub issue to report a bug or request a feature!\n\nFor developing the runbook application itself, [check this out](DEVELOPERS.md).\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhalidx%2Frunbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkhalidx%2Frunbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhalidx%2Frunbook/lists"}