# browser-sync-x

> Live CSS Reload & Browser Syncing

Latest version **2.7.5** (published 2015-05-22) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install browser-sync-x
pnpm add browser-sync-x
yarn add browser-sync-x
bun add browser-sync-x
```

Provides the command `browser-sync-x`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: no vulnerabilities; popular repo.

Warnings: low downloads; no types; no esm support.

Negative: insecure dependencies; abandoned.

## Facts

| | |
|---|---|
| Version | 2.7.5 |
| Published | 2015-05-22 |
| First published | 2015-05-22 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 30 |
| Known vulnerabilities | 0 (+13 in 5 direct dependencies) |
| Install scripts | no |
| GitHub stars | 12289 |
| Author | Shane Osbourne |
| Maintainers | cchamberlain |
| Keywords | browser sync, css, live reload, sync |

## Links

- npm: https://www.npmjs.com/package/browser-sync-x
- Repository: https://github.com/browsersync/browser-sync
- Homepage: http://www.browsersync.io/
- Issues: https://github.com/browsersync/browser-sync/issues
- npm.io page: https://npm.io/package/browser-sync-x

## Dependencies (30)

- [ws](https://npm.io/package/ws.md) ^0.7.2
- [opn](https://npm.io/package/opn.md) ^1.0.2
- [foxy](https://npm.io/package/foxy.md) ^10.1.2
- [meow](https://npm.io/package/meow.md) ^3.1.0
- [dev-ip](https://npm.io/package/dev-ip.md) ^1.0.1
- [lodash](https://npm.io/package/lodash.md) ^3.8.0
- [connect](https://npm.io/package/connect.md) ^3.3.5
- [longest](https://npm.io/package/longest.md) ^1.0.1
- [ucfirst](https://npm.io/package/ucfirst.md) ^0.0.1
- [anymatch](https://npm.io/package/anymatch.md) ^1.3.0
- [chokidar](https://npm.io/package/chokidar.md) ^1.0.1
- [pad-left](https://npm.io/package/pad-left.md) ^1.0.2
- [engine.io](https://npm.io/package/engine.io.md) github:automattic/engine.io#860af4dc0b47e55a623e7e56ce097ba4b610264b
- [immutable](https://npm.io/package/immutable.md) ^3.6.4
- [socket.io](https://npm.io/package/socket.io.md) ^1.3.5
- [eazy-logger](https://npm.io/package/eazy-logger.md) ^2.1.2
- [localtunnel](https://npm.io/package/localtunnel.md) ^1.3.0
- [portscanner](https://npm.io/package/portscanner.md) ^1.0.0
- [serve-index](https://npm.io/package/serve-index.md) ^1.6.3
- [query-string](https://npm.io/package/query-string.md) ^2.0.0
- [serve-static](https://npm.io/package/serve-static.md) ^1.9.1
- [ua-parser-js](https://npm.io/package/ua-parser-js.md) ^0.7.7
- [easy-extender](https://npm.io/package/easy-extender.md) ^2.3.1
- [resp-modifier](https://npm.io/package/resp-modifier.md) ^2.1.0
- [browser-sync-ui](https://npm.io/package/browser-sync-ui.md) ^0.5.8
- [emitter-steward](https://npm.io/package/emitter-steward.md) ^0.0.1
- [engine.io-client](https://npm.io/package/engine.io-client.md) github:automattic/engine.io-client#cffcc899546d451e53f7d8e8a309272f95099148
- [socket.io-client](https://npm.io/package/socket.io-client.md) github:automattic/socket.io-client#e898166382f7a811cf0e1b07b53ddb61b43b238a
- [async-each-series](https://npm.io/package/async-each-series.md) ^0.1.1
- [browser-sync-client](https://npm.io/package/browser-sync-client.md) ^2.0.2

## Alternatives

- [style-dictionary](https://npm.io/package/style-dictionary.md) — 2.0M weekly downloads
- [postcss-merge-idents](https://npm.io/package/postcss-merge-idents.md) — 1.7M weekly downloads
- [@fontsource/noto-sans](https://npm.io/package/@fontsource/noto-sans.md) — 93.0K weekly downloads
- [uglifycss](https://npm.io/package/uglifycss.md) — 71.6K weekly downloads
- [mat4-interpolate](https://npm.io/package/mat4-interpolate.md) — 23.3K weekly downloads

## Recent versions

- 2.7.5 (latest) — 2015-05-22
- 2.7.4 — 2015-05-22
- 2.7.3 — 2015-05-22

## README

<p align="center">
<a href="https://ci.appveyor.com/project/shakyShane/browser-sync" title="AppVeyor branch">
 <img src="https://img.shields.io/appveyor/ci/shakyshane/browser-sync/master.svg?style=flat-square&label=windows" />
</a>
<a href="https://travis-ci.org/BrowserSync/browser-sync" title="Travis branch">
 <img src="https://img.shields.io/travis/BrowserSync/browser-sync/master.svg?style=flat-square&label=linux" />
</a>
<a href="https://coveralls.io/r/BrowserSync/browser-sync?branch=master" title="Coverage Status">
 <img src="https://img.shields.io/coveralls/BrowserSync/browser-sync.svg?style=flat-square" />
</a>
<a href="https://www.npmjs.com/package/browser-sync">
 <img src="https://img.shields.io/npm/dm/browser-sync.svg?style=flat-square" />
</a>
</p>
<p align="center">
<a href="https://www.npmjs.com/package/browser-sync" title="NPM version">
 <img src="https://img.shields.io/npm/v/browser-sync.svg?style=flat-square" />
</a>
<a href="https://david-dm.org/BrowserSync/browser-sync" title="Dependency Status">
 <img src="https://img.shields.io/david/BrowserSync/browser-sync.svg?style=flat-square&label=deps" />
</a>
<a href="https://david-dm.org/BrowserSync/browser-sync#info=devDependencies" title="devDependency Status">
 <img src="https://img.shields.io/david/dev/BrowserSync/browser-sync.svg?style=flat-square&label=devDeps" />
</a>
</p>
<p align="center"><a href="http://www.wearejh.com"><img src="http://cl.ly/image/3Y3O0M2z310j/jh-100-red.png" /></a></p>
<h1 align="center">BrowserSync (with updated socket.io)</h1>
<p align="center">Keep multiple browsers & devices in sync when building websites.</p>

<p align="center">BrowserSync is developed and maintained internally at <a href="http://www.wearejh.com">JH</a></p>
<p align="center">Follow <a href="https://twitter.com/browsersync">@BrowserSync</a> on twitter for news & updates.</p>
<p align="center">Talk to contributors on <a href="https://gitter.im/BrowserSync/browser-sync"><img src="https://badges.gitter.im/Join%20Chat.svg" /></a></p>

***The original project is currently breaking on Windows due to references in the various socket.io/engine.io projects back to old versions of ws.  I forked the socket.io/engine.io projects, updated the references to use latest ws and pointed this forked browser-sync at the updated socket.io and it works for me again on Windows.  This has been an open issue for a while and doesn't seem to be getting much attention.***

***See:***

* (https://github.com/Automattic/socket.io/issues/2056#issuecomment-104475530)
* (https://github.com/Automattic/socket.io/issues/2114)

```sh
npm install -g browser-sync-x
```

or

```sh
npm install --save browser-sync-x
```


## Features

Please visit [browsersync.io](http://browsersync.io) for a full run-down of features

## Requirements

BrowserSync works by injecting an asynchronous script tag (`<script async>...</script>`) right after the `<body>` tag
during initial request. In order for this to work properly the `<body>` tag must be present. Alternatively you
can provide a custom rule for the snippet using [snippetOptions](http://www.browsersync.io/docs/options/#option-snippetOptions)

## Upgrading from 1.x to 2.x ?
Providing you havn't accessed any internal properties, everything will just work as
 there are no breaking changes to the public API. Internally however, we now use an
 immutable data structure for storing/retrieving options. So whereas before you could access urls like this...

```js
browserSync({server: true}, function(err, bs) {
    console.log(bs.options.urls.local);
});
```

... you now access them in the following way:

```js
browserSync({server: true}, function(err, bs) {
    console.log(bs.options.getIn(["urls", "local"]));
});
```

## Install and trouble shooting

[browsersync.io docs](http://browsersync.io)

## Integrations / recipes

[BrowserSync recipes](https://github.com/BrowserSync/recipes)

## Support

If you've found Browser-sync useful and would like to contribute to its continued development & support, please feel free to send a donation of any size - it would be greatly appreciated!

[![Support via Gittip](https://rawgithub.com/chris---/Donation-Badges/master/gittip.jpeg)](https://www.gittip.com/shakyshane)
[![Support via PayPal](https://rawgithub.com/chris---/Donation-Badges/master/paypal.jpeg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=shakyshane%40gmail%2ecom&lc=US&item_name=browser%2dsync)

## Contributors

```
   997	Shane Osbourne
    36	Shinnosuke Watanabe
    19	Shane Daniel
    13	Hugo Bessa
    11	Paul Kinlan
     8	shinnn
     4	Matt Green
     3	Marek 'saji' Augustynowicz
     3	Werner van Deventer
     3	Adam Lynch
     2	Eugeny Vlasenko
     2	Dan Tello
     2	Hugo Dias
     2	Michael Branch
     2	Olivier Combe
     2	Paul Robertson
     2	Piotr Kaleta
     2	Simen Bekkhus
     2	brutaldev
     2	chase_chou
     1	Michael Leigeber
     1	Craig Morris
     1	Paul Love
     1	Benjamín Eidelman
     1	Peter Blazejewicz
     1	Philipp Nowinski
     1	viktor hesselbom
     1	Robert Vock
     1	Christian Vuerings
     1	Cedric Kastner
     1	Carl Henderson
     1	mericson
     1	Sylvain Emery
     1	Tony Holdstock-Brown
     1	Guillaume Lambert
     1	Victor Fernandez de Alba
     1	Imran Sulemanji
     1	Jory Graham
     1	Dimitri Nicolas
     1	Dave Hall
     1	Cameron Spear
     1	Yazhong Liu
```

## License

Apache 2
Copyright (c) 2015 Shane Osbourne

---
_Source: https://npm.io/package/browser-sync-x · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._