The generated API clients are a work in progress, you can also find our stable clients on the Algolia documentation.

Skip to main content

Clients commands

The Clients commands are used to generate and build API clients.

Usage​

language and client defaults to all

The client parameter is variadic, you can pass multiple client name

bash
yarn docker generate <language | all> <client... | all>
bash
yarn docker generate <language | all> <client... | all>

Available options​

OptionCommandDescription
verbose-v, --verboseMake the process verbose, display logs from third party tools
interactive-i, --interactiveOpen prompt to query parameters

Generate​

Generate all clients for all supported languages​

bash
yarn docker generate
bash
yarn docker generate

Generate specific client for specific language​

bash
yarn docker generate java search
bash
yarn docker generate java search

Generate many client for specific language​

bash
yarn docker generate php insights recommend search
bash
yarn docker generate php insights recommend search

Build​

Build all clients for all supported languages​

bash
yarn docker build clients
bash
yarn docker build clients

Build specific client for specific language​

bash
yarn docker build clients javascript recommend
bash
yarn docker build clients javascript recommend

Build many client for specific language​

bash
yarn docker build clients php insights recommend search
bash
yarn docker build clients php insights recommend search