Installation

Prepare your environment

Node.js®

You need to have Node.js® installed and that can be done in a multitude of ways depending on your OS. But the most direct way is to use an installer from here.

There is no hard requirement for a specific version, the LTS version is a safe bet.

Enable the API server inside the Bitburner app

The menus for the Bitburner application contain a section about the API Server. That server needs to be enabled for bitburner-sync to be able to talk to the game.

It's recommended to enable autostart of the API Server if you are going to be syncing files often.

This is also where you access the unique auth/access token that you will need later.

Get bitburner-sync

1. You now need to create a directory/folder somewhere on your computer where you want to store the scripts for the game.

2. Navigate to that directory inside a terminal window (powershell or similar).

3. Execute npm i bitburner-sync

   That command will create 2 files and 1 folder where you are standing.

   • package.json - This file contains all settings for your node project (this folder). It will contain a reference to bitburner-sync and which version you request.
   • package-lock.json - This is an auto generated file (on npm install and npm update) that explicitly list all packages and versions (with all dependencies) that was installed.
   • node_modules - This folder contains the installed/downloaded npm packages and all dependencies. This folder can safely be deleted and recreated with npm install if need be.

4. Execute npx bitburner-sync --help to see your available options.

5. For more usage help see here.