Toolsync

Getting Started

How to get started with Toolsync.


To get started with Toolsync, you can either use the create command (described below) or install it manually. The create command is the recommended way to get started, as it will set up a new project with all the necessary configuration in no time. It works for both new and existing projects.

We recommend using bun or pnpm in the examples below.

Setup toolsync

bun create @toolsync
pnpm create @toolsync
npm init @toolsync
yarn create @toolsync

The create command will prompt you for some options, such as what built-in tools to setup.

Manual Setup

If you prefer, you can also manually setup Toolsync in your project.

Configure tools

Once you have set up Toolsync, you can configure it in the toolsync.json file in the root of your project. Continue to the configuration page to learn how.


Found an issue? Have a suggestion? Open an issue on GitHub ✨.

On this page


Edit this page on GitHub

Last modified: 2026-01-07