Manual Setup

It's highly recommended to use the create command to set up Toolsync in your project. However, if you prefer to do it manually, you can follow these steps.

Manual Installation

First of all, you need to install the Toolsync CLI. It's also recommended you install the @toolsync/builtin package. You can do this with your package manager of choice:

bun add -D @toolsync/cli @toolsync/builtin

pnpm add -Dw @toolsync/cli @toolsync/builtin

npm install --save-dev @toolsync/cli @toolsync/builtin

yarn add --save-dev @toolsync/cli @toolsync/builtin

Configuration

Now, create a toolsync.json file in the root of your project. It will configure any plugins you want to use.

{
  "@toolsync/builtin/package-readme": {}
}

See the Configuration page for details.

Create config files

Now that Toolsync is installed and configured, you can run toolsync prepare.

bun toolsync prepare --config toolsync.json

pnpm toolsync prepare --config toolsync.json

npx toolsync prepare --config toolsync.json

yarn toolsync prepare --config toolsync.json

Manual Installation

Configuration

Create config files

On this page