Skip to content

Installation

Requirements: Python 3.11 or higher.

Terminal window
pip install syncopate

For development (includes test and type-checking tools):

Terminal window
pip install syncopate[dev]
Terminal window
git clone https://github.com/Fixthemusic-com/syncopate.git
cd syncopate/sdk/python
pip install -e ".[dev]"

Requirements: Node.js 18 or higher.

Terminal window
npm install @syncopate/sdk

Or with yarn/pnpm:

Terminal window
yarn add @syncopate/sdk
pnpm add @syncopate/sdk
Terminal window
git clone https://github.com/Fixthemusic-com/syncopate.git
cd syncopate/sdk/typescript
npm install
npm run build

Every bot needs a token to authenticate. You can create one from your workspace settings:

  1. Go to Workspace Settings → Integrations → Bots
  2. Click Create Bot
  3. Copy the token (starts with bot_)
  4. Store it securely — never commit tokens to source control
Terminal window
# Set as environment variable
export BOT_TOKEN=bot_xxxx