{"id":19607872,"url":"https://github.com/mkdoc/mkcli-runtime","last_synced_at":"2025-04-27T20:32:27.874Z","repository":{"id":57298831,"uuid":"64822680","full_name":"mkdoc/mkcli-runtime","owner":"mkdoc","description":"Runtime plugins for command line interfaces","archived":true,"fork":false,"pushed_at":"2016-08-03T07:17:11.000Z","size":27,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-19T12:48:27.459Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mkdoc.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":"2016-08-03T06:52:44.000Z","updated_at":"2024-12-11T22:13:08.000Z","dependencies_parsed_at":"2022-08-26T18:12:38.353Z","dependency_job_id":null,"html_url":"https://github.com/mkdoc/mkcli-runtime","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdoc%2Fmkcli-runtime","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdoc%2Fmkcli-runtime/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdoc%2Fmkcli-runtime/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdoc%2Fmkcli-runtime/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mkdoc","download_url":"https://codeload.github.com/mkdoc/mkcli-runtime/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251204562,"owners_count":21552239,"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":[],"created_at":"2024-11-11T10:12:44.960Z","updated_at":"2025-04-27T20:32:27.578Z","avatar_url":"https://github.com/mkdoc.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Runtime Plugins\n\n[![Build Status](https://travis-ci.org/mkdoc/mkcli-runtime.svg?v=3)](https://travis-ci.org/mkdoc/mkcli-runtime)\n[![npm version](http://img.shields.io/npm/v/mkcli-runtime.svg?v=3)](https://npmjs.org/package/mkcli-runtime)\n[![Coverage Status](https://coveralls.io/repos/mkdoc/mkcli-runtime/badge.svg?branch=master\u0026service=github\u0026v=3)](https://coveralls.io/github/mkdoc/mkcli-runtime?branch=master)\n\n\u003e Runtime plugins for command line interfaces\n\nCollection of plugins for command line interfaces defined using the [mkcli][] tool.\n\n## Install\n\n```\nnpm i mkcli-runtime --save\n```\n\nFor the command line interface install [mkdoc][] globally (`npm i -g mkdoc`).\n\n---\n\n- [Install](#install)\n- [API](#api)\n  - [load](#load)\n  - [run](#run)\n- [License](#license)\n\n---\n\n## API\n\n### load\n\n```javascript\nload(def[, opts])\n```\n\nLoad a program definition into a new program assigning the definition\nproperties to the program.\n\nProperties are passed by reference so if you modify the definition the\nprogram is also modified.\n\nReturns a new program.\n\n* `def` Object the program definition.\n* `opts` Object program options.\n\n### run\n\n```javascript\nrun(src, argv[, runtime], cb)\n```\n\nLoad a program definition into a new program assigning the definition\nproperties to the program.\n\nProperties are passed by reference so if you modify the definition the\nprogram is also modified.\n\nThe callback function signature is `function(err, req)` where `req` is a\nrequest object that contains state information for program execution.\n\nPlugins may decorate the request object with pertinent information that\ndoes not affect the `target` object that receives the parsed arguments.\n\nReturns a new program.\n\n* `src` Object the source program or definition.\n* `argv` Array the program arguments.\n* `runtime` Object runtime configuration.\n* `cb` Function callback function.\n\n## License\n\nMIT\n\n---\n\nCreated by [mkdoc](https://github.com/mkdoc/mkdoc) on August 3, 2016\n\n[mkdoc]: https://github.com/mkdoc/mkdoc\n[mkcli]: https://github.com/mkdoc/mkcli\n[through]: https://github.com/tmpfs/through3\n[commonmark]: http://commonmark.org\n[jshint]: http://jshint.com\n[jscs]: http://jscs.info\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdoc%2Fmkcli-runtime","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmkdoc%2Fmkcli-runtime","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdoc%2Fmkcli-runtime/lists"}