{"id":13464973,"url":"https://github.com/mattdesl/budo","last_synced_at":"2026-10-19T09:06:44.377Z","repository":{"id":27333935,"uuid":"30808587","full_name":"mattdesl/budo","owner":"mattdesl","description":":clapper: a dev server for rapid prototyping","archived":false,"fork":false,"pushed_at":"2022-08-30T10:40:36.000Z","size":2445,"stargazers_count":2166,"open_issues_count":41,"forks_count":104,"subscribers_count":29,"default_branch":"master","last_synced_at":"2026-10-09T20:37:36.716Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/mattdesl.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-02-14T20:56:45.000Z","updated_at":"2026-09-30T15:40:17.000Z","dependencies_parsed_at":"2022-08-17T18:20:26.387Z","dependency_job_id":null,"html_url":"https://github.com/mattdesl/budo","commit_stats":null,"previous_names":["mattdesl/mystc"],"tags_count":129,"template":false,"template_full_name":null,"purl":"pkg:github/mattdesl/budo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattdesl%2Fbudo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattdesl%2Fbudo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattdesl%2Fbudo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattdesl%2Fbudo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mattdesl","download_url":"https://codeload.github.com/mattdesl/budo/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattdesl%2Fbudo/sbom","scorecard":{"id":625785,"data":{"date":"2025-08-11","repo":{"name":"github.com/mattdesl/budo","commit":"fc434246a5c63a64c3cb21368b7c7d956ec4575d"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.9,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":1,"reason":"Found 5/26 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.md:0","Info: FSF or OSI recognized license: MIT License: LICENSE.md:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 9 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"29 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-434g-2637-qmqr","Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m","Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw","Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p","Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747","Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh","Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-76c9-3jph-rj3q","Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6","Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg","Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-w5p7-h5w8-2hfq","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-21T06:24:56.566Z","repository_id":27333935,"created_at":"2025-08-21T06:24:56.566Z","updated_at":"2025-08-21T06:24:56.566Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":344872684,"owners_count":38352878,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-10-03T21:59:58.778Z","status":"online","status_checked_at":"2026-10-19T02:00:06.414Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2024-07-31T14:00:53.755Z","updated_at":"2026-10-19T09:06:44.000Z","avatar_url":"https://github.com/mattdesl.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","工程","others","Tools"],"sub_categories":["redux 扩展","macros","Development Servers"],"readme":"# budō\n\n[![build status][travis-image]][travis-url]\n[![stability][stability-image]][stability-url]\n[![NPM version][npm-image]][npm-url]\n[![Downloads][downloads-image]][downloads-url]\n[![js-standard-style][standard-image]][standard-url]\n\nThis is a [browserify](https://github.com/substack/node-browserify) development server focused on incremental reloading, LiveReload integration (including CSS injection) and other high-level features for rapid prototyping.\n\nTo install it globally:\n\n```sh\nnpm install budo -g\n```\n\nRunning budo will start a server with a default `index.html` and incrementally bundle your source on filesave. The requests are delayed until the bundle has finished, so you won't be served stale or empty bundles if you refresh the page mid-update. Examples:\n\n```sh\n# serve file on port 9966 and open browser\nbudo index.js --open\n\n# enable LiveReload on HTML/CSS/JS file changes\nbudo index.js --live\n\n# default html will use src=\"static/bundle.js\"\nbudo src/index.js:static/bundle.js\n\n# pass some options to browserify\nbudo index.js --live -- -t babelify\n\n# use HTTPS and enable CORS headers\nbudo index.js --ssl --cors\n\n# LiveReload public directory without any bundling\n# Add all extensions of file types you want to trigger reloads\nbudo --dir public/ --wg **/*.{html,css,js} --live\n```\n\nThen open [http://localhost:9966/](http://localhost:9966/) to see the content in action.\n\nBy default, budo pretty-prints to terminal with [garnish](https://github.com/mattdesl/garnish).\n\n\u003ccenter\u003e\u003cimg src=\"https://raw.githubusercontent.com/mattdesl/budo/master/screenshots/terminal.png\" width=\"75%\" /\u003e\u003c/center\u003e\n\nSee [docs](#docs) for more details and integrations, such as [React Hot Module Replacement](./docs/command-line-usage.md#hot-module-replacement), [Pushstate Servers](./docs/command-line-usage.md#pushstate) and [HTTPS](./docs/command-line-usage.md#ssl-and-https). PRs/suggestions/comments welcome.\n\n## features\n\nAt a glance:\n\n- serves a default `index.html`\n- fast incremental bundling, suspending the response until the new source is ready\n- watches HTML and CSS files for changes; CSS is injected without reloading the page\n- can emit [ndjson](http://ndjson.org) logs to use another pretty-printer, like [bistre](https://github.com/hughsk/bistre).\n- provides clear error messaging during development in DOM and console\n- supports SSL and can generate a self-signed certificate\n- the rich API allows you to build more complex development tools on top of budo\n\nBelow is an example of how syntax errors look during development, using the [babelify](https://github.com/babel/babelify) transform.\n\n\u003ccenter\u003e\u003cimg src=\"https://raw.githubusercontent.com/mattdesl/budo/master/screenshots/build-error.png\" width=\"75%\" /\u003e\u003c/center\u003e\n\n## docs\n\n- [command line usage](./docs/command-line-usage.md)\n- [API usage](./docs/api-usage.md)\n- [running tests and examples](./docs/tests-and-examples.md)\n- [rapid prototyping with budō](http://mattdesl.svbtle.com/rapid-prototyping)\n- [experimental script injection with budo-chrome](https://github.com/mattdesl/budo-chrome)\n\n## usage\n\n[![NPM](https://nodei.co/npm/budo.png)](https://www.npmjs.com/package/budo)\n\n### CLI\n\nDetails for `budo` command-line interface.\n\n```txt\nUsage:\n  budo index.js [opts] -- [browserify opts]\n\nOptions:\n  --help, -h       show help message\n  --version        show version\n  --port, -p       the port to run, default 9966\n  --host, -H       the host, default internal IP (localhost)\n  --dir, -d        a path, or array of paths for base static content\n  --serve, -s      override the bundle path being served\n  --live, -l       enable default LiveReload integration\n  --live-port, -L  the LiveReload port, default 35729\n  --open, -o       launch the browser once connected\n  --pushstate, -P  always render the index page instead of a 404 page\n  --base           set the base path for the generated HTML, default to '/'\n  --onupdate       a shell command to trigger on bundle update\n  --poll=N         use polling for file watch, with optional interval N\n  --title          optional title for default index.html\n  --css            optional stylesheet href for default index.html\n  --ssl, -S        create an HTTPS server instead of HTTP\n  --cert, -C       the cert for SSL (default cert.pem)\n  --key, -K        the key for SSL (default key.pem)\n  --cors           set header to use CORS (Access-Control-Allow-Origin: *)\n  --ndjson         print ndjson instead of pretty-printed logs\n  --verbose, -v    also include debug messages\n  --force-default-index always serve a generated index.html instead of a static one\n  --no-stream      do not print messages to stdout\n  --no-debug       do not use inline source maps\n  --no-portfind    will not attempt auto-portfinding\n  --no-error-handler    disable default DOM error handling\n  --watch-glob, --wg    glob(s) to watch for reloads, default '**/*.{html,css}'\n  --static-options      subarg options to pass to serve-static module\n```\n\nBy default, messages will be printed to `process.stdout`, and `--debug` will be sent to browserify (for source maps). You can turn these off with `--no-stream` and `--no-debug`, respectively.\n\nEverything after `--` is passed directly to browserify. Example:\n\n```js\nbudo index.js --live -- -t [ babelify --extensions .es6 ]\n```\n\n### API\n\nThe API mirrors the CLI except it does not write to `process.stdout` by default.\n\n```js\nvar budo = require('budo')\nvar babelify = require('babelify')\n\nbudo('./src/index.js', {\n  live: true,             // setup live reload\n  port: 8000,             // use this port\n  browserify: {\n    transform: babelify   // ES6\n  }\n}).on('connect', function (ev) {\n  console.log('Server running on %s', ev.uri)\n  console.log('LiveReload running on port %s', ev.livePort)\n}).on('update', function (buffer) {\n  console.log('bundle - %d bytes', buffer.length)\n})\n```\n\nSee [API usage](docs/api-usage.md) for details.\n\n## See Also\n\nbudō combines several smaller and less opinionated modules.\n\n- [watchify-middleware](https://www.npmjs.com/package/watchify-middleware) - the underlying request handler for serving incremental reloads\n- [watchify-server](https://www.npmjs.com/package/watchify-server) - a less opinionated alternative to budo, built on the same underlying modules\n- [simple-html-index](https://www.npmjs.com/package/simple-html-index) - a stream for a default `index.html` file\n\nAlso, special thanks to [beefy](https://github.com/chrisdickinson/beefy) and [wzrd](https://github.com/maxogden/wzrd) which originally inspired budo.\n\n## License\n\nMIT, see [LICENSE.md](http://github.com/mattdesl/budo/blob/master/LICENSE.md) for details.\n\n[stability-image]: https://img.shields.io/badge/stability-stable-brightgreen.svg?style=flat-square\n[stability-url]: https://nodejs.org/api/documentation.html#documentation_stability_index\n[npm-image]: https://img.shields.io/npm/v/budo.svg?style=flat-square\n[npm-url]: https://npmjs.org/package/budo\n[travis-image]: https://img.shields.io/travis/mattdesl/budo/master.svg?style=flat-square\n[travis-url]: http://travis-ci.org/mattdesl/budo\n[downloads-image]: http://img.shields.io/npm/dm/budo.svg?style=flat-square\n[downloads-url]: https://npmjs.org/package/budo\n[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square\n[standard-url]: https://github.com/feross/standard\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattdesl%2Fbudo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmattdesl%2Fbudo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattdesl%2Fbudo/lists"}