# sync-bitburner

> Rework of the official implementation of the Bitburner Filesync server

Latest version **1.0.0** (published 2023-12-12) · 0 weekly downloads

## Install

```sh
npm install sync-bitburner
pnpm add sync-bitburner
yarn add sync-bitburner
bun add sync-bitburner
```

Provides the command `sync-bitburner`.

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-12-12 |
| First published | 2023-12-12 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 25.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | srbrahma |
| Keywords | bitburner, rfa, remote, sync |

## Links

- npm: https://www.npmjs.com/package/sync-bitburner
- Repository: https://github.com/SrBrahma/sync-bitburner
- Homepage: https://github.com/SrBrahma/sync-bitburner#readme
- Issues: https://github.com/SrBrahma/sync-bitburner/issues
- npm.io page: https://npm.io/package/sync-bitburner

## Dependencies (5)

- [ws](https://npm.io/package/ws.md) ^8.8.1
- [globby](https://npm.io/package/globby.md) ^13.2.2
- [chokidar](https://npm.io/package/chokidar.md) ^3.5.3
- [commander](https://npm.io/package/commander.md) ^11.1.0
- [@commander-js/extra-typings](https://npm.io/package/@commander-js/extra-typings.md) ^11.1.0

## Alternatives

- [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads
- [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads
- [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads
- [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads
- [fa](https://npm.io/package/fa.md) — 185 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2023-12-12

## README

# bitburner-sync

Rework of [bitburner-filesync](https://github.com/bitburner-official/bitburner-filesync). The original didn't work when the game was running on Windows and the sync on WSL.

This also is a way cleaner and simpler implementation.

## Usage

```bash
npm i bitburner-sync
# or
npx bitburner-sync [options]
```

```
Options:
  -p, --port <number>  the port to be used (default: 12525)
  -s, --src <dir>      where the source .js files are located (default: "dist")
  -d, --dest <dir>     where the files are stored in the game's home server (default: "scripts")
  -h, --help           display help for command
```

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