This monorepo contains the following packages:

Package	Description	Version
@coze/api	Coze API
@coze/realtime-api	Realtime API

Find usage examples for each package in the examples directory:

• coze-js-node - Node.js Demo for @coze/coze-js
• coze-js-web - React Web Demo for @coze/coze-js
• realtime-console - Full Console Demo for @coze/realtime-api
• realtime-call-up - Sample Call Up Demo for @coze/realtime-api

• Node.js 18+ (LTS/Hydrogen recommended)
• pnpm 9.12.0
• Rush 5.14.0

1. Install Node.js 18+

nvm install lts/hydrogen
nvm alias default lts/hydrogen # set default node version
nvm use lts/hydrogen

2. Clone the repository

git clone [email protected]:coze-dev/coze-js.git

3. Install required global dependencies

npm i -g [email protected] @microsoft/[email protected]

4. Install project dependencies

rush update

After that, you can start to develop projects inside this repository.

Enjoy it!

Each package in this monorepo can be developed and published independently. To start developing:

1. Navigate to the package directory:

cd packages/<package-name>

2. Start development:

npm run start

• Contributing Guidelines

MIT