Skip to main content
Syncmaven can be installed as a Docker image or an NPM package. Docker is the recommended way to use Syncmaven.

​
Docker

Syncmaven is available as a Docker image - syncmaven.
1

Create a project directory

mkdir ./syncmaven-example
2

Initialize the project

docker run --rm -v ./syncmaven-example:/project syncmaven/syncmaven init
syncmaven/syncmaven docker image assumes that the project located in docker image /project directory. It should be mounted to the local host directory where the project is located.
3

Edit the project

Edit the project files in the ./syncmaven-example.
4

Run all syncs

docker run --rm -v ./syncmaven-example:/project syncmaven/syncmaven sync
Explore other commands by running docker run --rm syncmaven --help.

​
NPM

Syncmaven is also available as an NPM package - syncmaven. It can be installed locally and used as a CLI tool. Make sure you have Node.js installed on your machine, and it’s version is 20 or higher.
Syncmaven NPM package is not stable yet. You may face issues during installation. If you do, please use the Docker image.
npm install -g syncmaven
Then you can use syncmaven command to run the tool. 
syncmaven init -d ./syncmaven-example # Initialize the project
syncmaven sync -d ./syncmaven-example # Run all syncs
syncmaven help # Explore other commands

​
Next steps

Take a look at the examples to see how Syncmaven can be used in real life: Get yourself familiar with the fundamentals:

Project

How to create a project and its structure

Model

How to define a model, an SQL query that tells Syncmaven how to fetch data

Destination

How to define a destination, a place where the data will be synced

Sync

A process that connects a model with a destination