ardrive-sync

The ArDrive Sync Command Line App contains basic public and private drive synchronization via a Node.js application.

It requires you to provide a local Arweave wallet JSON. It stores this, encrypted, in local SQLite database that is created in the directory that you run ArDrive-Sync in, called .ardrive-sync.db. Other file metadata and transaction information is also stored in this database.

To use the ArDrive Sync, install it with your favorite package manager, and run "ardrive-sync".

If you are experiencing permissions issues (Mac OSX), you may also need to place your wallet file in the same directory you are running ardrive-cli

---- THIS IS CURRENTLY A BETA VERSION ----

Developer Setup

First, clone this repository to a local directory

git clone -b production https://github.com/ardriveapp/ardrive-sync.git ./ardrive-sync

Install Yarn 2

ArDrive Sync uses Yarn 2, so install the latest version with the yarn installation instructions. In most cases:

# Brew:
brew install yarn

# Or with NPM:
npm install -g yarn

We also use husky. To enable hooks locally, you will need to run:

yarn husky install

Building, Installing and Starting ArDrive Sync

Now that everything is set up, to install the package simply run:

yarn

And then start the ArDrive Sync command line app:

yarn start

Installing and Starting ArDrive Sync with NPM

ArDrive-Sync is also available via NPM. It can be installed globally by running the following:

npm install ardrive-sync -g

And then start the ArDrive Sync command line app:

ardrive-sync

Recommended Visual Studio Code extensions

To ensure your environment is compatible, we also recommend the following VSCode extensions:

• ES-Lint
• Editor-Config
• Prettier
• ZipFS