node-sdk/examples
Christopher Crone 868903f63d examples: Add README
Signed-off-by: Christopher Crone <christopher.crone@docker.com>
2020-06-09 17:15:30 +02:00
..
README.md examples: Add README 2020-06-09 17:15:30 +02:00
context-ls.ts Initial commit 2020-06-09 13:08:34 +02:00
ps.ts Initial commit 2020-06-09 13:08:34 +02:00

README.md

Examples

This folder contains examples of how to use the Docker CLI JavaScript SDK.

Prerequisites

To run the examples you will need to have the Docker CLI API server running. You can do this by running:

$ docker serve --address unix:///tmp/backend.sock

To make sure that you have the example dependencies installed, use:

$ yarn

Running examples

You can then run any an example from the root of this repository as follows:

$ npm run example examples/<file>

List of examples