Setup repository

info

Make sure to have Docker installed so you don't have to install the tooling for every API clients. Installation guide

Install the dependencies

nvm use && yarn

Mounting the docker image

You can also execute docker commands one by one, see Docker commands

yarn docker:setup

Docker

Build

Image is built from the Dockerfile

yarn docker:build

Mount

Mount docker image on dev container

yarn docker:mount

Clean

Stops dev container and clean the built image

yarn docker:clean

Contribute

Once you've successfully built and mounted the Docker image, you can now play with the repository! Read our guides on:

• How to add a new client
• How to add a new language
• Use CLI specs commands
• Use CLI clients commands
• Use CLI Common Test Suite commands

Troubleshooting

caution

You should run the commands via the Docker container to avoid issues.

Error: The operation couldn't be completed. Unable to locate a Java Runtime.

Java is not located in your PATH, either source the right .bash_profile, .zshrc, etc. file or do the following command in this repository:

echo 'export PATH="/usr/local/opt/openjdk/bin:$PATH"' > .bash_profile && source .bash_profile