Skip to main content

​
Using the CLI

Want to be able to tunnel your webhooks to your local machine? Use the CLI to get the best experience possible. Whether you want to tunnel DEV, STAGING, or PROD webhooks to your local machine, the CLI has you covered.

​
Installation

To get started, you will need to install the CLI globally. 
pnpm add syncd-cli --global

npm install syncd-cli --g

yarn add syncd-cli --g

​
Running the CLI

When you want to run the CLI, you will need to first create a Project. To do so, head to the Dashboard and create a new project. You will need the Project ID to run the CLI. You will also need a CLI API Key. You can get that in your dashboard > project > Local Tunneling tab. Then run this command: 
syncd-cli start --port 3001 --path /api/webhooks --api-key <your-api-key> --project-id <your-project-id>
This command will start the CLI, allowing you to tunnel your webhooks to your local machine on port 3001. Replace <your-api-key> and <your-project-id> with your actual API key and project ID. With Syncd’s CLI, you can seamlessly test and develop your webhook integrations locally, ensuring a smooth and efficient workflow.