cozy-client

• Describe your data and their relationships
• Fetch data from your Cozy and put it in a normalized store
• Refresh your React components when your data changes
• Have your data available offline

cozy-client is a convenient yet powerful way to bind cozy-stack queries to your (p)React components — but you can still benefit of it if you're not using React!

Getting started

To get started with cozy-client, follow this tutorial.

Architecture

If you want to better understand the cozy-client concepts, see the architecture doc.

Advanced

• API docs

  • cozy-client
  • cozy-pouch-link
  • cozy-stack-client

• Relationships

• Mobile guide

• Link authoring

This is the documentation for the current version of cozy-client. If you want to check the old version, go to the old version 👵👴.

Contributing

Use Node 24 and Yarn 4

yarn install
yarn build         # required before tests: packages resolve each other from dist/
yarn lint
yarn test
yarn docs          # regenerates docs/api/** (typedoc)
yarn types         # regenerates packages/*/types/** (tsc, from JSDoc)
yarn bench         # micro-benchmarks, see packages/cozy-client/benchmarks/README.md

ℹ docs/api/** and packages/*/types/** are committed. CI regenerates them and fails if they differ from what you pushed, so run yarn docs and yarn types before every push and commit the result.

Commits follow Conventional Commits (checked by commitlint). Agent rules live in AGENTS.md, publishing and linking in docs/dev.md.