ComposeDB packages are still under development and only released as a developer preview, they are not ready for production use.
There may be breaking changes between v0.x versions before a stable v1.0 version is released, causing models or composites created from previous versions not to be compatible.
ComposeDB runs on top of Ceramic. Running a local Ceramic node is needed for app development.
ComposeDB provides libraries and a CLI to help support common development needs.
The CLI provides commands for the most common flows, while the libraries can be used in scripts to support more complex use-cases.
npm install --location=global @composedb/cli@^0.3.0
pnpm add -g @composedb/cli@^0.3.0
Global packages are only supported for yarn 2.x and older. For yarn 3.x and newer, use
yarn dlx to run composedb cli commands
yarn global add @composedb/cli@^0.3.0
ComposeDB exposes two complementary development libraries:
@composedb/devtools for generic interactions with composites, and
@composedb/devtools-node with additional functions to interact with the local file system and start a local HTTP server.
npm install -D @composedb/devtools@^0.3.0 @composedb/devtools-node@^0.3.0
pnpm add -D @composedb/devtools@^0.3.0 @composedb/devtools-node@^0.3.0
yarn add -D @composedb/devtools@^0.3.0 @composedb/devtools-node@^0.3.0
@composedb/client package exposes the primary APIs to interact with Ceramic based on a Composite definition.
npm install @composedb/client@^0.3.0
pnpm add @composedb/client@^0.3.0
yarn add @composedb/client@^0.3.0
You may need to install the
@composedb/types package used by the different libraries if you use TypeScript.
npm install -D @composedb/types@^0.3.0
pnpm add -D @composedb/types@^0.3.0
yarn add -D @composedb/types@^0.3.0