Skip to content

coze-dev/coze-js

Repository files navigation

Monorepo of Coze Orz

codecov ci

English | 简体中文

📦 Packages

This monorepo contains the following packages:

Package Description Version
@coze/api Coze API SDK npm
@coze/realtime-api Realtime API SDK npm
@coze/taro-api Taro Mini Program Coze API SDK npm

🎮 Examples

Find usage examples for each package in the examples directory:

🚀 Getting Started

Prerequisites

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

Installation

  1. Install Node.js 18+
nvm install lts/hydrogen
nvm alias default lts/hydrogen # set default node version
nvm use lts/hydrogen
  1. Clone the repository
git clone [email protected]:coze-dev/coze-js.git
  1. Install required global dependencies
  1. Install project dependencies
rush update
  1. Build the project
rush build

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

Enjoy it!

🔨 Development

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

  1. Navigate to the package directory:
cd packages/<package-name>
  1. Start development:
npm run start

📖 Documentation

📄 License

MIT